Email Placeholders

Application Models Survey

    //$url = App()->createUrl('survey/index', $urlParams);
    $url = App()->createPublicUrl('survey/index', $urlParams);

Can you tell us which file and line you're suggesting a change?

Oh, the Survey model. Will check.

Hello juliodiz,
This should already be fixed in recent versions.
Can you please check if this issue still exists in the latest version of LimeSurvey and let us know?
Thank you!

Thanks!
Same problem here
I am using last version Confort Update and still having this issue.

[2023-07-21T22:44:11-03:00] [INFO] Start sendMailByCron for 455337
CException: ConsoleApplication and its behaviors do not have a method or closure named "createPublicUrl". in /var/www/public/vendor/yiisoft/yii/framework/base/CComponent.php:266
Stack trace:
#0 /var/www/public/application/models/Survey.php(2355): CComponent->__call('createPublicUrl', Array)

Problem when using

/usr/bin/php /var/www/public/application/commands/console.php plugin cron --interval=1

Its not working using the php script console to run and send the email.

Need to change
$url = App()->createUrl('survey/index', $urlParams);
to
$url = App()->createAbsoluteUrl('survey/index', $urlParams);

We are facing the same "CException: ConsoleApplication and its behaviors do not have a method or closure named "createPublicUrl"" problem. Our inviter and reminder cronjob scripts (https://survey-consulting.com/product-category/limesurvey-plugins/limesurvey-cronjob-scripts) are showing an error when being run on console.
This problem showed up just recently at the latest 5.6.33 version.

please also fix the 5.x branch

What is the timeframe for fixing this issue ?
Currently : all console plugin sending mail are broken.

I'd also like to second that this issue breaks many of our plugins, so a fast fix would be much appreciated.

When applying similar changes in the future, please keep such console things in mind. This was broken several times in the past.

The bug exist in version 5.6.34, but not in 5.6.16!

Was related to new feature «Survey alias»

@ollehar : if you don't have time : i need it before try fixing sendMailCron,
Then : you can assign it to me.

I was just asking this morning about this ticket.
We can take it.
Let me know if you want me to take it or you prefer to do it.

Thanks

If you think you can fix before end of week : feel free to take it.

@gabrieljenik : remind the publicurl config settings :)

Sure... Let me work a bit on it and push something...

v5: https://github.com/LimeSurvey/LimeSurvey/pull/3454

Please consider the following when reviewing:
Had to add these to the config:

• Config section ('publicurl'=>'https://limesurvey.example.org:8000/limesurvey')
• Components section ('request ' => ['baseUrl' => '/limesurvey'])

As this is only required when running ConsoleApplication, maybe there is the need of having specific config for console?

v5: https://github.com/LimeSurvey/LimeSurvey/pull/3454

1. This issue is ONLY for V6 , and are not related to console
2. No new issue with console and createPublicUrl if i don't make error.

As this is only required when running ConsoleApplication, maybe there is the need of having specific config for console?

This is a new feature and must be reported separatly.

@juliodiz : i check on last git version : seems OK (via web)

Except it don't use publicurl of config.

@gabrieljenick :

Config section ('publicurl'=>'https://limesurvey.example.org:8000/limesurvey')

You can set whole baseUrl in publicurl : 'publicurl' => 'https://www.example.org/example/' work (in current master too).

@DenisChenu

re: https://github.com/LimeSurvey/LimeSurvey/pull/3454#pullrequestreview-1632679815
The issue is said to be in console application, so we ported the URL methods to ConsoleApplication.
Why you say is not related?

Was related to new feature «Survey alias»

I am no that sure.
Issue seems to have started here when model got dependen on the application.
https://github.com/LimeSurvey/LimeSurvey/commit/3c7045423a5918987840f2723d7ca2e7f4097823

@mazi @francois-charles.hebert @juliodiz
Maybe you can help testing the PR?

@bismark, please have a look and check to what extend this affects our Inviter and Reminder cronjobs.

The issue is said to be in console application, so we ported the URL methods to ConsoleApplication.

Look at the issue

Summary 18961: {SURVEYURL} not complete URL
Description

{SURVEYURL} don't show complete URL

/index.php/215424?token=test1&lang=en-US
Steps To Reproduce
Steps to reproduce

Use {SURVEYURL}
Expected result

https://survey.com/index.php/215424?token=test1&lang=en-US
Actual result

/index.php/215424?token=test1&lang=en-US

Where did you see console application here ?

Issue seems to have started here when model got dependen on the application.

Yes, but why fix it in 5.X then ?
There are another issue to report for console here https://bugs.limesurvey.org/view.php?id=18961#c76235

But only for 6.X

Yes, but why fix it in 5.X then ?

It is blocking. If fixes are similar, we cna port one to the other.

It is blocking. If fixes are similar, we cna port one to the other.

Oh right : the issue wityh console happen too

Just when call Survey->getSurveyUrl()

@juliodiz : can you confirem something : you report the issue only for console or there are another issue ?

{SURVEYURL} i use at email and remember email. When i use sendmailbycron URL was missing. (sendmailcron)

{SURVEYURL} i use at email and remember email. When i use sendmailbycron URL was missing. (sendmailcron)

You deactivate error to have the mail sent ?
Because i have CException: ConsoleApplication and its behaviors do not have a method or closure named "createPublicUrl" and it broke!?

Why you din't report at https://gitlab.com/SondagesPro/mailing/sendMailCron/-/issues ?

Checked with no update on sendMail Cron

• OK with publicurl
• KO with only sendMailCron config : https://gitlab.com/SondagesPro/mailing/sendMailCron/-/blob/master/sendMailCron.php?ref_type=heads#L696-703

With https://github.com/LimeSurvey/LimeSurvey/commit/55d9eda4c9407db6982dfad0ae8355dfc3c0d572 (parent of https://github.com/LimeSurvey/LimeSurvey/commit/3c7045423a5918987840f2723d7ca2e7f4097823 ) :

• OK with only sendMailCron config

@gabrieljenik it looks like there is more work to be done here. Any update on this?

@Mazi and @bismark : did you test with your own plugin ?

sendMailCron didn't work, but create a fix is easy.

@gabrieljenik it looks like there is more work to be done here. Any update on this?

What;s pending?

We just wait test from @Mazi or @bismark , no ?

/**
     * php application/commands/console.php plugin --target=Mailer
     */
    public function direct()
    {
        $event = $this->getEvent();
        $target = $event->get('target');
        if ($target != get_class()) return;

        $baseUrl = $this->get('baseUrl');
        Yii::app()->setConfig('publicurl', $baseUrl);
        $survey = Survey::model()->findByPk(646148);
        var_dump($survey->getSurveyUrl();
    }

OK, then don't work : right ?

Thanks for testing

//in config.php you can define a baseUrl
'urlManager' => array(
            'baseUrl' => 'http://dev5.localhost',
            'urlFormat' => 'path',
            'rules' => array(
                // You can add your own rules here
            ),
            'showScriptName' => true,
        ),

then the following code works, the $preferShortUrl branch not

$survey = Survey::model()->findByPk(646148);
        var_dump($survey->getSurveyUrl(null, [], false));

        'baseUrl' => 'http://dev5.localhost',

We can not force using baseUrl in config.php : a lot of user have access to same DB from different URL (and some just for admin).

Hey.
Update last version confortupdate , using sendmailcron error:

[2023-09-27T12:04:58-03:00] [INFO] Start sendMailByCron for 692856
CException: ConsoleApplication and its behaviors do not have a method or closure named "createPublicUrl". in public/vendor/yiisoft/yii/framework/base/CComponent.php:266

We can not force using baseUrl in config.php : a lot of user have access to same DB from different URL (and some just for admin).

And more the question is to don't force any admin user to set someting in config.php, must work with Plugin config set.

Plugin can easily set publicurl before usage (App()->setConfig is public, and maybe we can move it to LimeSurveyAPI)

If current PR work with (App()->setConfig('publicurl'),"http.example.org") inside a plughin : let's go ?

Update the last version and still the same problem:

http://index.php/238118?token=Q8eBcFasdsadasdqeL&lang=en

Still need to change

Application Models Survey

$url = App()->createAbsoluteUrl('survey/index', $urlParams);

@juliodiz this is not released yet. If you want to test, please use the PR in this post: https://bugs.limesurvey.org/view.php?id=18961#c77120

@DenisChenu

If current PR work with (App()->setConfig('publicurl'),"http.example.org") inside a plughin : let's go ?

Haven't tested it, but following the automatic tests, I would say it works.
You tested somethingsimilar on your plugin, right?

@bismark

the $preferShortUrl branch not

You have set publicUrl?

Also, have you tried setting the request->hostinfo ?
Also, setting the baseUrl of the request as well, because hostinfo will look for it when it does not have a baseurl.

A clarification regarding setting the baseUrl: there are two.

• One is the one for the request
• and another is the one for the url manager.

Both are needed.

You tested somethingsimilar on your plugin, right?

Not currently, wait for feedback from @bismark

Hi,
I tested some things related to this. It might be helpful, otherwise don't mind this note.

1- I managed to trigger sendMailCron using the CLI while using this https://github.com/LimeSurvey/LimeSurvey/pull/3454 (LS v5.6.37, PHP 8.0.2, sendMailCron version 4.3.2) without any errors. (see first picture for cli results)
Note: i did not edit the config file beforehand.
I received the email with complete url.
''
Cliquez ici pour remplir ce questionnaire :
http://limesurvey.local.e-alpha.ca/index.php?r=survey/index&token=test123&sid=729582&lang=fr

Si vous ne souhaitez pas participer à ce questionnaire et ne souhaitez plus recevoir aucune invitation, veuillez cliquer sur le lien suivant :
http://limesurvey.local.e-alpha.ca/index.php?r=optout/tokens&surveyid=729582&token=test123&langcode=fr

Si vous êtes sur liste noire mais que vous voulez participer à ce questionnaire et recevoir les invitations, merci de cliquer sur le lien suivant :
http://limesurvey.local.e-alpha.ca/index.php?r=optin/tokens&surveyid=729582&token=test123&langcode=fr
''

2- I tried this line as mentionned in another comment: php application/commands/console.php plugin --target=Mailer, but did not seems to do anything on my installation. (No exception raised, nothing).

Is there any other specific test that needs to be done?

Note: i did not edit the config file beforehand.
I received the email with complete url

Strange, Maybe it was already set?

*/
return array(

// 'request' => ['baseUrl' => '/LimeSurvey'],
'components' => array(
    'db' => array(
        'connectionString' => 'mysql:host=localhost;port=3306;dbname=limesurvey;',
        'emulatePrepare' => true,
        'username' => 'root',
        'password' => '',
        'charset' => 'utf8mb4',
        'tablePrefix' => 'lime_',
    ),

    'session' => array(
        'sessionName' => 'LS-ZTZQQQPRUJMTJHLT',
        // Uncomment the following lines if you need table-based sessions.
        // Note: Table-based sessions are currently not supported on MSSQL server.
        // 'class' => 'application.core.web.DbHttpSession',
        // 'connectionID' => 'db',
        // 'sessionTableName' => '{{sessions}}',
    ),

    'urlManager' => array(
        'urlFormat' => 'get',
        'rules' => array(// You can add your own rules here
        ),
        'showScriptName' => true,
    ),

    'log' => array(
        'routes' => array(
            'allError' => array(
                'class' => 'CFileLogRoute',
                'levels' => 'error',
                // 'levels' => 'info, error, warning',
                'logFile' => 'logs/app.log',
            ),
        ),
    ),
),

// For security issue : it's better to set runtimePath out of web access
// Directory must be readable and writable by the webuser
// 'runtimePath'=>'/var/limesurvey/runtime/'
// Use the following config variable to set modified optional settings copied from config-defaults.php
'config' => array(
    // 'publicurl' => 'https://limesurvey.local.e-alpha.ca/',

    // debug: Set this to 1 if you are looking for errors. If you still get no errors after enabling this
    // then please check your error-logs - either in your hosting provider admin panel or in some /logs directory
    // on your webspace.
    // LimeSurvey developers: Set this to 2 to additionally display STRICT PHP error messages and get full access to standard templates
    'debug' => 2,
    'debugsql' => 0, // Set this to 1 to enanble sql logging, only active when debug = 2
    // Mysql database engine (INNODB|MYISAM):
    'mysqlEngine' => 'MYISAM',        // Update default LimeSurvey config here
)

);
</pre>

I ran the following command:
<pre>
php -d memory_limit=768M C:\laragon\www\limesurvey\application\commands\console.php plugin cron sendMailCronDebug=3 sendMailCronType=12h00 --interval=60
</pre>

Which, if i understand correctly, trigger the CLI event for plugin.

I kept the default email template, which contains the {SURVEYURL}, and the link in the received email is complete:

<pre>
Dear François Charles,

You have been invited to participate in a survey.

The survey is titled:
"test fix sendMailCron with Survey url"

""

To participate, please click on the link below.

Sincerely,

Dialogs Brio (info@dialogsbriodemo.com)

Click here to do the survey:
http://limesurvey.local.e-alpha.ca/index.php?r=survey/index&amp;token=7hItBEkyPLjlqCc&amp;sid=837923&amp;lang=fr

If you do not want to participate in this survey and don't want to receive any more invitations please click the following link:
http://limesurvey.local.e-alpha.ca/index.php?r=optout/tokens&amp;surveyid=837923&amp;token=7hItBEkyPLjlqCc&amp;langcode=fr

If you are blacklisted but want to participate in this survey and want to receive invitations please click the following link:
http://limesurvey.local.e-alpha.ca/index.php?r=optin/tokens&amp;surveyid=837923&amp;token=7hItBEkyPLjlqCc&amp;langcode=fr
</pre>

All i did was checkout on the branch https://github.com/LimeSurvey/LimeSurvey/tree/bug/18961--SURVEYURL-not-complete-URL , create a new survey with participant, configure send mail cron for the survey and then trigger manually the command.

On the 5.x branch, if i run the same command, it raises the following error:

[2023-11-27T17:47:26+00:00] [TRACE] Send : francois-charles.hebert@dialogs.ca (1) for 837923
CException: ConsoleApplication and its behaviors do not have a method or closure named "createPublicUrl". in C:\laragon\www\LimeSurvey\vendor\yiisoft\yii\framework\base\CComponent.php:266
Stack trace:
#0 C:\laragon\www\LimeSurvey\application\models\Survey.php(2386): CComponent->__call('createPublicUrl', Array)
#1 C:\laragon\www\LimeSurvey\application\core\LimeMailer.php(826): Survey->getSurveyUrl('en', Array)
#2 C:\laragon\www\LimeSurvey\application\core\LimeMailer.php(855): LimeMailer->getTokenReplacements()
#3 C:\laragon\www\LimeSurvey\application\core\LimeMailer.php(566): LimeMailer->doReplacements('Invitation to p...')
#4 C:\laragon\www\LimeSurvey\plugins\sendMailCron\sendMailCron.php(979): LimeMailer->sendMessage()
#5 C:\laragon\www\LimeSurvey\plugins\sendMailCron\sendMailCron.php(782): sendMailCron->sendEmails('837923', 'invite')
#6 C:\laragon\www\LimeSurvey\plugins\sendMailCron\sendMailCron.php(341): sendMailCron->sendTokenMessages()
#7 [internal function]: sendMailCron->sendMailByCron()
#8 C:\laragon\www\LimeSurvey\application\libraries\PluginManager\PluginManager.php(269): call_user_func(Array)
#9 C:\laragon\www\LimeSurvey\application\commands\PluginCommand.php(38): LimeSurvey\PluginManager\PluginManager->dispatchEvent(Object(PluginEvent))
#10 [internal function]: PluginCommand->actionCron('60')
#11 C:\laragon\www\LimeSurvey\vendor\yiisoft\yii\framework\console\CConsoleCommand.php(178): ReflectionMethod->invokeArgs(Object(PluginCommand), Array)
#12 C:\laragon\www\LimeSurvey\vendor\yiisoft\yii\framework\console\CConsoleCommandRunner.php(71): CConsoleCommand->run(Array)
#13 C:\laragon\www\LimeSurvey\vendor\yiisoft\yii\framework\console\CConsoleApplication.php(92): CConsoleCommandRunner->run(Array)
#14 C:\laragon\www\LimeSurvey\vendor\yiisoft\yii\framework\base\CApplication.php(185): CConsoleApplication->processRequest()
#15 C:\laragon\www\LimeSurvey\application\commands\console.php(77): CApplication->run()
#16 {main}

On the 5.x branch, if i run the same command, it raises the following error:
Yes, the fix is not merged on 5.x

Note: i did not edit the config file beforehand.
I received the email with complete url

Does that make sense @DenisChenu?

Does that make sense @DenisChenu?

Seems great ! Let's go :)

(Still : i need to fix the way sendMailCron plugin do it : i think usage of publicurl is better, i do it after the commit is done)

ready for merge ?

@DenisChenu Some conflicts need to be resolved first https://github.com/LimeSurvey/LimeSurvey/pull/3454

Ready

Fix committed to 5.x branch: http://bugs.limesurvey.org/plugin.php?page=Source/view&amp;id=35795

We are facing the same "CException: ConsoleApplication and its behaviors do not have a method or closure named "createPublicUrl"" problem. Our inviter and reminder cronjob scripts (https://doodlejumping.com) are showing an error when being run on console.
This problem showed up just recently at the latest 5.6.33 version.

@cartwheeljoint: We have just released updated versions of the "Inviter" and "Reminder" email plugins. If you have purchased them within the last 12 months, you should be able to download the Limesurvey plugins for free.
You can find all latest fixed and new feature added at the "Changelog" tab at:
https://survey-consulting.com/product/automatically-send-email-invitations/
https://survey-consulting.com/product/automatically-send-email-reminders/

Master: https://github.com/LimeSurvey/LimeSurvey/pull/3645

Fixed in Release 5.6.48+231205

I assign it to me for testing too :)

Wondering if we should create a new story for this:

Had to add these to the config:

• Config section ('publicurl'=>'https://limesurvey.example.org:8000/limesurvey')
• Components section ('request ' => ['baseUrl' => '/limesurvey'])
  As this is only required when running ConsoleApplication, maybe there is the need of having specific config for console?

Or add it somewhere as comments in a config? Or somewhere in the doc?

Wondering if we should create a new story for this:

There are no current console action sending email, then set publicurl (or other way) are the responsibility to plugin dev.

But : why not add it to API : it can be interesting

There are no current console action sending email, then set publicurl (or other way) are the responsibility to plugin dev.

We can provide something as to ease that.
It is not much of a hassle to allow a specific config file only for console that would allow extra configs.

It is not much of a hassle to allow a specific config file only for console that would allow extra configs.

publicurl is used for all links

Else : https://github.com/LimeSurvey/LimeSurvey/blob/master/application/config/console.php

1. Unsure it was loaded,
2. Can include a config-console if exist

good idea :)

Fix committed to master branch: http://bugs.limesurvey.org/plugin.php?page=Source/view&amp;id=35805

Since other user test it and i test it (and commit is clean !)

Merged

Fixed in Release 6.3.9+231211