Dolibarr/sendrecurringinvoicebymail
1
0
Fork 0
Code Issues Pull requests Releases 6 Activity Actions

Compare commits

base: Dolibarr:master
Branches Tags
Dolibarr:master
Dolibarr:doleditor
Dolibarr:0.3.6
Dolibarr:0.3.5
Dolibarr:0.3.4
Dolibarr:0.3.3
Dolibarr:0.3.2
Dolibarr:0.3.1
..
compare: Dolibarr:0.3.1
Branches Tags
Dolibarr:master
Dolibarr:doleditor
Dolibarr:0.3.6
Dolibarr:0.3.5
Dolibarr:0.3.4
Dolibarr:0.3.3
Dolibarr:0.3.2
Dolibarr:0.3.1

No commits in common. "master" and "0.3.1" have entirely different histories.
master ... 0.3.1

11 changed files with 57 additions and 430 deletions
Download patch file Download diff file Expand all files Collapse all files

74
.forgejo/workflows/generate-release-zipfile.yml
View file

@ -1,74 +0,0 @@
# Creates a module_sendrecurringinvoicebymail-X.Y.Z.zip file when pushing a tag
#
# This job is mainly useless (Forgejo already creates a usable .zip archive,
# minus the name) and serves more as a warmup for a decent CI/CD tryout.
on:
push:
tags:
# For the time being, we only trigger on the tags clearly matching a
# '1.2.3' version pattern.
- '[0-9]+.[0-9]+.[0-9]+'
env:
MYFILENAME: "module_sendrecurringinvoicebymail-${{ github.ref_name }}"
jobs:
GenerateReleaseZipfile:
runs-on: docker
container:
image: code.bugness.org/chl/alpine-wget-git-zip:latest
steps:
- name: Download the automatic repository archive
run: |
# In case the repository is private, we build an authenticated URL
# with our action token.
MY_GITHUB_AUTHENTICATED_URL="$( echo "$GITHUB_SERVER_URL" | sed "s#^\(https\?://\)#\1$GITHUB_TOKEN\@#" )"
wget -O "$MYFILENAME.zip" "$MY_GITHUB_AUTHENTICATED_URL"/"$GITHUB_REPOSITORY"/archive/"$GITHUB_REF_NAME".zip
- name: A bit of useless cleanup
run: |
#apk add zip
# On Forgejo, GITHUB_REPOSITORY="owner/repo" (and we just want the 'repo' part)
MY_REPOSITORY="$( echo "$GITHUB_REPOSITORY" | sed 's/.*\///' )"
zip -d "$MYFILENAME.zip" \
"$MY_REPOSITORY/.editorconfig" \
"$MY_REPOSITORY/.gitattributes" \
"$MY_REPOSITORY/.gitignore" \
"$MY_REPOSITORY/.tx*"
- name: Upload artifact (using v4)
run: |
set -ex
# The busybox version of wget does not offer --method=PUT as of 2024-08-26
#apk add wget
# We extract the Actions.Results:22:33 from ACTIONS_RUNTIME_TOKEN
# (base64 -d doesn't like when the '==' padding is missing, so 2>/dev/null and relying on the piping to forget about non-zero return code...)
read WORKFLOW_RUN_BACKEND_ID WORKFLOW_JOB_RUN_BACKEND_ID <<EOF
$( echo "$ACTIONS_RUNTIME_TOKEN" | sed 's/.*\.\(.*\)\..*/\1/' | base64 -d 2>/dev/null | sed 's/.*Actions.Results:\([^:]\+\):\([^:" ]\+\).*/\1 \2/' )
EOF
# Get the upload URL
# note: we use the name without .zip, it seems to be added automatically.
RESPONSE="$( wget -O - \
--header 'Content-Type:application/json' \
--header "Authorization: Bearer $GITHUB_TOKEN" \
--post-data "$( printf '{"version":4, "name":"%s", "workflow_run_backend_id":"%s", "workflow_job_run_backend_id":"%s"}' "$MYFILENAME" "$WORKFLOW_RUN_BACKEND_ID" "$WORKFLOW_JOB_RUN_BACKEND_ID" )" \
"$GITHUB_SERVER_URL"/twirp/github.actions.results.api.v1.ArtifactService/CreateArtifact
)"
# We get a JSON with an signedUploadUrl similar to :
# https://entrepot.xlii.si/twirp/github.actions.results.api.v1.ArtifactService/UploadArtifact?sig=yWWEI8tIIECp8D7E5TVh4_6G2pZxWaVdQcSYaCsx5s0=&expires=2024-08-26+07%3A20%3A49.886890537+%2B0200+CEST&artifactName=mymodule-1.2.3.zip&taskID=63
SIGNED_UPLOAD_URL="$( echo "$RESPONSE" | sed -n 's/.*"signedUploadUrl" *: *"\([^"]\+\)".*/\1/p' )"
# Upload our file
# (note: adding '&comp=block' at the end of the URL)
wget --method PUT --body-file "$MYFILENAME.zip" "$SIGNED_UPLOAD_URL&comp=block"
# Finalize the artifact
wget -O - \
--header 'Content-Type:application/json' \
--header "Authorization: Bearer $GITHUB_TOKEN" \
--post-data "$( printf '{"hash":"sha256:%s", "name":"%s", "size":"%d", "workflow_run_backend_id":"%s", "workflow_job_run_backend_id":"%s"}' "$( sha256sum $MYFILENAME.zip | sed 's/[[:space:]]\+.*//' )" "$MYFILENAME" "$( stat -c %s $MYFILENAME.zip )" "$WORKFLOW_RUN_BACKEND_ID" "$WORKFLOW_JOB_RUN_BACKEND_ID" )" \
"$GITHUB_SERVER_URL"/twirp/github.actions.results.api.v1.ArtifactService/FinalizeArtifact

36
ChangeLog.md
View file

@ -1,38 +1,4 @@
# CHANGELOG SENDRECURRINGINVOICEBYMAIL FOR [DOLIBARR ERP CRM](https://www.dolibarr.org) # CHANGELOG SENDRECURRINGINVOICEBYMAIL FOR <a href="https://www.dolibarr.org">DOLIBARR ERP CRM</a>
## 0.3.6
Fix: freeform email addresses being "html-filtered" `Postmaster <postmaster@bugness.org>` → `Postmaster`
## 0.3.5
Fix:
* HTML formating was silently removed when used on Dolibarr v.13+ (GH-11)
* `$conf->global->MAIN_MAIL_ERRORS_TO` might not always be set (cause not found)
## 0.3.4
Fix: the hook was also triggered by supplier invoices.
Thanks to jpardenoy for the report and the fix.
## 0.3.3
Fix: adds CSRF protection.
## 0.3.2
Note: This release includes a DB schema modification. Reactivate the module to trigger it.
Enhancements:
* Mails can now be sent in HTML (via global module configuration and via the customzation tab).
* Mails can now be sent even when the invoice is a draft.
## 0.3.1 ## 0.3.1

27
README.md
View file

@ -2,9 +2,9 @@
## Features ## Features
(en) This module sends by email the customer invoice generated with a recurring invoice template via scheduled jobs. (en) This module send the invoice generated with recurring invoices by email to the client.
(fr) Ce module envoie par mail les factures clientes générées automatiquement par les travaux planifiés et les factures modèles. (fr) Ce module envoie par mail les factures générées automatiquement par les travaux planifiés et les factures modèles.
You can customize the mail globally or by recurring invoice. You can customize the mail globally or by recurring invoice.
@ -14,7 +14,7 @@ To edit the default global mail template, go to Home > Setup > Emails > Email te
To edit the default sender address, go to Home > Setup > Emails, and edit the `Sender email for automatic emails` field. To edit the default sender address, go to Home > Setup > Emails, and edit the `Sender email for automatic emails` field.
This module hooks himself on the end of the `Recurring invoices` job from the Scheduled jobs (aka. `cron`) module. It will only be triggered via this Scheduled job and will not send mail when manually generating an invoice from a recurring invoice template. This module is triggered by the cron (Scheduled jobs module) and will not send emails when manually generating an invoice.
## Requirements ## Requirements
@ -30,18 +30,11 @@ Other modules are available on <a href="https://www.dolistore.com" target="_new"
### From the ZIP file and GUI interface ### From the ZIP file and GUI interface
Go to `Home` > `Setup` > `Modules/Applications` and finally the `Deploy/install external app/module` tab - If you get the module in a zip file (like when downloading it from the market place [Dolistore](https://www.dolistore.com)), go into
and upload the module_sendrecurringinvoicebymail-x.y.z.zip file (you can get it from the menu ```Home - Setup - Modules - Deploy external module``` and upload the zip file.
[original forge](https://code.bugness.org/Dolibarr/sendrecurringinvoicebymail/releases)
or [Github](https://github.com/bugness-chl/sendrecurringinvoicebymail/releases)).
Next, on the `Modules/Applications` page, activate the newly available sendrecurringinvoicebymail module,
and probably the Scheduled jobs (alias cron or modCron) integrated module too.
#### Troubleshooting Note: If this screen tell you there is no custom directory, check your setup is correct:
Note: If the module screen tells you there is no custom directory, check that your setup is correct:
- In your Dolibarr installation directory, edit the ```htdocs/conf/conf.php``` file and check that following lines are not commented: - In your Dolibarr installation directory, edit the ```htdocs/conf/conf.php``` file and check that following lines are not commented:
@ -72,10 +65,12 @@ Note: If the module screen tells you there is no custom directory, check that yo
```sh ```sh
cd ....../custom cd ....../custom
git clone https://code.bugness.org/Dolibarr/sendrecurringinvoicebymail.git sendrecurringinvoicebymail git clone git@github.com:bugness-chl/sendrecurringinvoicebymail.git sendrecurringinvoicebymail
``` ```
Then, from your browser: ### Final steps
From your browser:
- Log into Dolibarr as a super-administrator - Log into Dolibarr as a super-administrator
- Go to "Setup" -> "Modules" - Go to "Setup" -> "Modules"
@ -99,7 +94,7 @@ GPLv3 or (at your option) any later version.
See file COPYING for more information. See file COPYING for more information.
### Documentation #### Documentation
All texts and readmes. All texts and readmes.

181
admin/setup.php
View file

@ -1,181 +0,0 @@
<?php
/* Copyright (C) 2004-2017 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2021 Chl <chl-dev@bugness.org>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* \file sendrecurringinvoicebymail/admin/setup.php
* \ingroup sendrecurringinvoicebymail
* \brief SRIBM setup page.
*/
// Load Dolibarr environment
$res=0;
// Try main.inc.php into web root known defined into CONTEXT_DOCUMENT_ROOT (not always defined)
if (! $res && ! empty($_SERVER["CONTEXT_DOCUMENT_ROOT"])) $res=@include $_SERVER["CONTEXT_DOCUMENT_ROOT"]."/main.inc.php";
// Try main.inc.php into web root detected using web root calculated from SCRIPT_FILENAME
$tmp=empty($_SERVER['SCRIPT_FILENAME'])?'':$_SERVER['SCRIPT_FILENAME'];$tmp2=realpath(__FILE__); $i=strlen($tmp)-1; $j=strlen($tmp2)-1;
while($i > 0 && $j > 0 && isset($tmp[$i]) && isset($tmp2[$j]) && $tmp[$i]==$tmp2[$j]) { $i--; $j--; }
if (! $res && $i > 0 && file_exists(substr($tmp, 0, ($i+1))."/main.inc.php")) $res=@include substr($tmp, 0, ($i+1))."/main.inc.php";
if (! $res && $i > 0 && file_exists(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php")) $res=@include dirname(substr($tmp, 0, ($i+1)))."/main.inc.php";
// Try main.inc.php using relative path
if (! $res && file_exists("../../main.inc.php")) $res=@include "../../main.inc.php";
if (! $res && file_exists("../../../main.inc.php")) $res=@include "../../../main.inc.php";
if (! $res) die("Include of main fails");
global $langs, $user;
// Libraries
require_once DOL_DOCUMENT_ROOT . "/core/lib/admin.lib.php";
//require_once '../lib/mymodule.lib.php';
//require_once "../class/myclass.class.php";
// Translations
$langs->loadLangs(array("admin", "sendrecurringinvoicebymail@sendrecurringinvoicebymail"));
// Access control
if (! $user->admin) accessforbidden();
// Parameters
$action = GETPOST('action', 'alpha');
$backtopage = GETPOST('backtopage', 'alpha');
$arrayofparameters=array(
//'SENDRECURRINGINVOICEBYMAIL_MYPARAM2'=>array('css'=>'minwidth500','enabled'=>1)
'SENDRECURRINGINVOICEBYMAIL_BODY_ISHTML_DEFAULT' => array(
'css' => 'minwidth200',
'selectvalues' => array(
-1 => 'MailBodyFormatAutoDetect',
0 => 'MailBodyFormatPlainText',
1 => 'MailBodyFormatHtml',
),
),
);
/*
* Actions
*/
if ((float) DOL_VERSION >= 6)
{
include DOL_DOCUMENT_ROOT.'/core/actions_setmoduleoptions.inc.php';
}
/*
* View
*/
$page_name = "sendrecurringinvoicebymailSetup";
llxHeader('', $langs->trans($page_name));
// Subheader
$linkback = '<a href="'.($backtopage?$backtopage:DOL_URL_ROOT.'/admin/modules.php?restore_lastsearch_values=1').'">'.$langs->trans("BackToModuleList").'</a>';
print load_fiche_titre($langs->trans($page_name), $linkback, 'object_mymodule@mymodule');
// Configuration header
//$head = mymoduleAdminPrepareHead();
$head = array();
dol_fiche_head($head, 'settings', '', -1, "sendrecurringinvoicebymail@sendrecurringinvoicebymail");
// Setup page goes here
echo '<span class="opacitymedium">'.$langs->trans("sendrecurringinvoicebymailSetupPage").'</span><br><br>';
if ($action == 'edit')
{
print '<form method="POST" action="'.$_SERVER["PHP_SELF"].'">';
print '<input type="hidden" name="token" value="'.$_SESSION['newtoken'].'">';
print '<input type="hidden" name="action" value="update">';
print '<table class="noborder" width="100%">';
print '<tr class="liste_titre"><td class="titlefield">'.$langs->trans("Parameter").'</td><td>'.$langs->trans("Value").'</td></tr>';
foreach($arrayofparameters as $key => $val)
{
print '<tr class="oddeven"><td>';
$tooltiphelp = (($langs->trans($key.'Tooltip') != $key.'Tooltip') ? $langs->trans($key.'Tooltip') : '');
print $form->textwithpicto($langs->trans($key), $tooltiphelp);
print "</td>\n";
print '<td>';
if (isset($val['selectvalues'])) {
// Select input
print '<select name="' . $key . '">';
foreach ($val['selectvalues'] as $k => $item) {
print '<option value="' . $k . '"';
if ($k == $conf->global->$key) {
print ' selected="selected"';
}
print '>' . $langs->trans($item) . "</option>\n";
}
print "</select>\n";
} else {
// Simple input
print '<input name="'.$key.'" class="flat '.(empty($val['css'])?'minwidth200':$val['css']).'" value="' . $conf->global->$key . '">';
}
print "</td></tr>\n";
}
print '</table>';
print '<br><div class="center">';
print '<input class="button" type="submit" value="'.$langs->trans("Save").'">';
print '</div>';
print '</form>';
print '<br>';
}
else
{
if (! empty($arrayofparameters))
{
print '<table class="noborder centpercent">';
print '<tr class="liste_titre"><td class="titlefield">'.$langs->trans("Parameter").'</td><td>'.$langs->trans("Value").'</td></tr>';
foreach($arrayofparameters as $key => $val)
{
print '<tr class="oddeven"><td>';
$tooltiphelp = (($langs->trans($key.'Tooltip') != $key.'Tooltip') ? $langs->trans($key.'Tooltip') : '');
print $form->textwithpicto($langs->trans($key), $tooltiphelp);
print '</td><td>' . $conf->global->$key . '</td></tr>';
}
print '</table>';
print '<div class="tabsAction">';
print '<a class="butAction" href="'.$_SERVER["PHP_SELF"].'?action=edit">'.$langs->trans("Modify").'</a>';
print '</div>';
}
else
{
print '<br>'.$langs->trans("NothingToSetup");
}
// Display a notice if the 'cron' module is not enabled
if (! in_array('cron', $conf->modules, true)) {
print '<div class="info"><p>' . $langs->trans('NoticeCronIsDisabled') . "</p></div>\n";
}
}
// Page end
dol_fiche_end();
llxFooter();
$db->close();

23
class/actions_sendrecurringinvoicebymail.class.php
View file

@ -84,23 +84,15 @@ class Actionssendrecurringinvoicebymail
$error = 0; // Error counter $error = 0; // Error counter
$facturerec = $parameters['facturerec']; $facturerec = $parameters['facturerec'];
// Since Dolibarr 16, this hook is also used for the FactureFournisseurRec class.
if (! $facturerec instanceof FactureRec) {
return 0;
}
// Load our own object, linked to this facture
// (if it doesn't exist in database, fetch(,,true) will fill the object
// from the global mail template)
$mailObject = new SRIBMCustomMailInfo($this->db); $mailObject = new SRIBMCustomMailInfo($this->db);
if ($mailObject->fetch(null, $facturerec->id, true) != 1) { if ($mailObject->fetch(null, $facturerec->id, true) != 1) {
dol_syslog("Error loading SRIBMCustomMailInfo for facture rec " . (isset($facturerec->id) ? $facturerec->id : "(facturerec->id not set ??)")); dol_syslog("Error loading SRIBMCustomMailInfo for facture rec " . (isset($facturerec->id) ? $facturerec->id : "(facturerec->id not set ??)"));
return -1; return -1;
} }
// Abort sending when inactive // We only send the mail when the invoice is not a draft
// (draft invoice or explictly disabled) // and the sending is enabled for the template.
if (!$mailObject->active) { if ($object->brouillon || !$mailObject->active) {
return 0; return 0;
} }
@ -120,11 +112,10 @@ class Actionssendrecurringinvoicebymail
'to' => implode(', ', $mailObject->compileEmails('to', true)), 'to' => implode(', ', $mailObject->compileEmails('to', true)),
'cc' => implode(', ', $mailObject->compileEmails('cc', true)), 'cc' => implode(', ', $mailObject->compileEmails('cc', true)),
'bcc' => implode(', ', $mailObject->compileEmails('bcc', true)), 'bcc' => implode(', ', $mailObject->compileEmails('bcc', true)),
'errorsTo' => (isset($conf->global->MAIN_MAIL_ERRORS_TO) ? $conf->global->MAIN_MAIL_ERRORS_TO : ''), 'errorsTo' => $conf->global->MAIN_MAIL_ERRORS_TO,
'replyTo' => (isset($conf->global->MAIN_MAIL_ERRORS_TO) ? $conf->global->MAIN_MAIL_ERRORS_TO : ''), 'replyTo' => $conf->global->MAIN_MAIL_ERRORS_TO,
'subject' => $mailObject->subject, 'subject' => $mailObject->subject,
'message' => $mailObject->body, 'message' => $mailObject->body_plaintext,
'ishtml' => $mailObject->body_ishtml,
); );
// Check that we have a recipient, to avoid some frequent error... // Check that we have a recipient, to avoid some frequent error...
@ -163,7 +154,7 @@ class Actionssendrecurringinvoicebymail
$mail_data['cc'], // CC $mail_data['cc'], // CC
$mail_data['bcc'], // BCC $mail_data['bcc'], // BCC
0, //deliveryreceipt 0, //deliveryreceipt
$mail_data['ishtml'], //msgishtml 0, //msgishtml
$mail_data['errorsTo'], $mail_data['errorsTo'],
'', // css '', // css
'', // trackid '', // trackid

27
class/sribmcustommailinfo.class.php
View file

@ -109,12 +109,12 @@ class SRIBMCustomMailInfo extends CommonObject
/** /**
* @var string * @var string
*/ */
public $body; public $body_plaintext;
/** /**
* @var int 0: plain text, 1: html, -1: auto (see CMailFile and dol_ishtml()) * @var string (not used at the moment)
*/ */
public $body_ishtml = 0; public $body_html;
// End of database fields // End of database fields
@ -228,7 +228,7 @@ class SRIBMCustomMailInfo extends CommonObject
$sql .= " SET "; $sql .= " SET ";
$sql .= " fk_facture_rec = " . (int)$this->fk_facture_rec; $sql .= " fk_facture_rec = " . (int)$this->fk_facture_rec;
$sql .= ", active = " . (int)$this->active; $sql .= ", active = " . (int)$this->active;
$sql .= ", addmaindocfile = " . (int)$this->addmaindocfile; $sql .= ", addmaindocfile = '" . (int)$this->addmaindocfile . "'";
$sql .= ", fromtype = '" . $this->db->escape($this->fromtype) . "'"; $sql .= ", fromtype = '" . $this->db->escape($this->fromtype) . "'";
$sql .= ", frommail = '" . $this->db->escape($this->frommail) . "'"; $sql .= ", frommail = '" . $this->db->escape($this->frommail) . "'";
$sql .= ", sendto_thirdparty = " . (int)$this->db->escape($this->sendto_thirdparty); $sql .= ", sendto_thirdparty = " . (int)$this->db->escape($this->sendto_thirdparty);
@ -238,8 +238,8 @@ class SRIBMCustomMailInfo extends CommonObject
$sql .= ", sendbcc_thirdparty = " . (int)$this->db->escape($this->sendbcc_thirdparty); $sql .= ", sendbcc_thirdparty = " . (int)$this->db->escape($this->sendbcc_thirdparty);
$sql .= ", sendbcc_free = '" . $this->db->escape($this->sendbcc_free) . "'"; $sql .= ", sendbcc_free = '" . $this->db->escape($this->sendbcc_free) . "'";
$sql .= ", subject = '" . $this->db->escape($this->subject) . "'"; $sql .= ", subject = '" . $this->db->escape($this->subject) . "'";
$sql .= ", body = '" . $this->db->escape($this->body) . "'"; $sql .= ", body_plaintext = '" . $this->db->escape($this->body_plaintext) . "'";
$sql .= ", body_ishtml = " . (int)$this->body_ishtml; $sql .= ", body_html = '" . $this->db->escape($this->body_html) . "'";
$sql .= " WHERE rowid = " . (int)$this->id; $sql .= " WHERE rowid = " . (int)$this->id;
$result = $this->db->query($sql); $result = $this->db->query($sql);
@ -281,7 +281,7 @@ class SRIBMCustomMailInfo extends CommonObject
{ {
global $conf; global $conf;
$sql = "SELECT rowid, fk_facture_rec, active, addmaindocfile, fromtype, frommail, sendto_thirdparty, sendto_free, sendcc_thirdparty, sendcc_free, sendbcc_thirdparty, sendbcc_free, subject, body, body_ishtml"; $sql = "SELECT rowid, fk_facture_rec, active, addmaindocfile, fromtype, frommail, sendto_thirdparty, sendto_free, sendcc_thirdparty, sendcc_free, sendbcc_thirdparty, sendbcc_free, subject, body_plaintext, body_html";
$sql .= " FROM " . MAIN_DB_PREFIX . $this->table_element; $sql .= " FROM " . MAIN_DB_PREFIX . $this->table_element;
$sql .= " WHERE " . (isset($ref) ? 'fk_facture_rec = ' . (int)$ref : "rowid = " . (int)$rowid); $sql .= " WHERE " . (isset($ref) ? 'fk_facture_rec = ' . (int)$ref : "rowid = " . (int)$rowid);
@ -309,8 +309,8 @@ class SRIBMCustomMailInfo extends CommonObject
$this->sendbcc_thirdparty = $obj->sendbcc_thirdparty; $this->sendbcc_thirdparty = $obj->sendbcc_thirdparty;
$this->sendbcc_free = $obj->sendbcc_free; $this->sendbcc_free = $obj->sendbcc_free;
$this->subject = $obj->subject; $this->subject = $obj->subject;
$this->body = $obj->body; $this->body_plaintext = $obj->body_plaintext;
$this->body_ishtml = $obj->body_ishtml; $this->body_html = $obj->body_html;
$ref = $obj->fk_facture_rec; $ref = $obj->fk_facture_rec;
} elseif (!$fill_defaults_from_template) { } elseif (!$fill_defaults_from_template) {
$this->error = "SRIBMCustomMailInfo not found (id: " . var_export($rowid, true) . ", ref: " . var_export($ref, true); $this->error = "SRIBMCustomMailInfo not found (id: " . var_export($rowid, true) . ", ref: " . var_export($ref, true);
@ -366,15 +366,8 @@ class SRIBMCustomMailInfo extends CommonObject
} }
$this->subject = $template->topic; $this->subject = $template->topic;
$this->body = $template->content; $this->body_plaintext = $template->content;
$this->addmaindocfile = $template->joinfiles; $this->addmaindocfile = $template->joinfiles;
// By default, we don't send emails when the generated invoice is
// still a draft.
$this->active = $this->fac_rec_object->auto_validate;
// Retrieve the default body format from config.
$this->body_ishtml = $conf->global->SENDRECURRINGINVOICEBYMAIL_BODY_ISHTML_DEFAULT;
} }
return 1; return 1;

17
core/modules/modsendrecurringinvoicebymail.class.php
View file

@ -52,7 +52,7 @@ class modsendrecurringinvoicebymail extends DolibarrModules
// Family can be 'base' (core modules),'crm','financial','hr','projects','products','ecm','technic' (transverse modules),'interface' (link with external tools),'other','...' // Family can be 'base' (core modules),'crm','financial','hr','projects','products','ecm','technic' (transverse modules),'interface' (link with external tools),'other','...'
// It is used to group modules by family in module setup page // It is used to group modules by family in module setup page
$this->family = "financial"; $this->family = "crm";
// Module position in the family on 2 digits ('01', '10', '20', ...) // Module position in the family on 2 digits ('01', '10', '20', ...)
$this->module_position = '90'; $this->module_position = '90';
// Gives the possibility for the module, to provide his own family info and position of this family (Overwrite $this->family and $this->module_position. Avoid this) // Gives the possibility for the module, to provide his own family info and position of this family (Overwrite $this->family and $this->module_position. Avoid this)
@ -69,7 +69,7 @@ class modsendrecurringinvoicebymail extends DolibarrModules
$this->editor_url = 'https://code.bugness.org/Dolibarr/sendrecurringinvoicebymail'; $this->editor_url = 'https://code.bugness.org/Dolibarr/sendrecurringinvoicebymail';
// Possible values for version are: 'development', 'experimental', 'dolibarr', 'dolibarr_deprecated' or a version string like 'x.y.z' // Possible values for version are: 'development', 'experimental', 'dolibarr', 'dolibarr_deprecated' or a version string like 'x.y.z'
$this->version = '0.3.6'; $this->version = '0.3.1';
//Url to the file with your last numberversion of this module //Url to the file with your last numberversion of this module
//$this->url_last_version = 'http://www.example.com/versionmodule.txt'; //$this->url_last_version = 'http://www.example.com/versionmodule.txt';
@ -103,7 +103,7 @@ class modsendrecurringinvoicebymail extends DolibarrModules
$this->dirs = array("/sendrecurringinvoicebymail/temp"); $this->dirs = array("/sendrecurringinvoicebymail/temp");
// Config pages. Put here list of php page, stored into sendrecurringinvoicebymail/admin directory, to use to setup module. // Config pages. Put here list of php page, stored into sendrecurringinvoicebymail/admin directory, to use to setup module.
$this->config_page_url = array("setup.php@sendrecurringinvoicebymail"); //$this->config_page_url = array("setup.php@sendrecurringinvoicebymail");
// Dependencies // Dependencies
$this->hidden = false; // A condition to hide module $this->hidden = false; // A condition to hide module
@ -124,15 +124,6 @@ class modsendrecurringinvoicebymail extends DolibarrModules
// 1=>array('SENDRECURRINGINVOICEBYMAIL_MYNEWCONST2','chaine','myvalue','This is another constant to add',0, 'current', 1) // 1=>array('SENDRECURRINGINVOICEBYMAIL_MYNEWCONST2','chaine','myvalue','This is another constant to add',0, 'current', 1)
// ); // );
$this->const = array( $this->const = array(
0 => array(
'SENDRECURRINGINVOICEBYMAIL_BODY_ISHTML_DEFAULT', // key
'chaine', // always 'chaine' ?
'0', // value
'default format for mail body : -1 for auto-detect, 0 for plain text, 1 for HTML.', // desc
1, // visible
'current', // current or allentities
0, // deleteonunactive
),
//1=>array('SENDRECURRINGINVOICEBYMAIL_MYCONSTANT', 'chaine', 'avalue', 'This is a constant to add', 1, 'allentities', 1) //1=>array('SENDRECURRINGINVOICEBYMAIL_MYCONSTANT', 'chaine', 'avalue', 'This is a constant to add', 1, 'allentities', 1)
); );
@ -366,7 +357,7 @@ class modsendrecurringinvoicebymail extends DolibarrModules
$this->db->query("INSERT INTO " . MAIN_DB_PREFIX . "sribm_custom_mail_info (fk_facture_rec, fromtype, frommail) VALUES (" . (int)$row->rid . ", 'robot', '" . $this->db->escape($conf->global->MAIN_MAIL_EMAIL_FROM) . "')"); $this->db->query("INSERT INTO " . MAIN_DB_PREFIX . "sribm_custom_mail_info (fk_facture_rec, fromtype, frommail) VALUES (" . (int)$row->rid . ", 'robot', '" . $this->db->escape($conf->global->MAIN_MAIL_EMAIL_FROM) . "')");
$sid = $this->db->last_insert_id(MAIN_DB_PREFIX . 'sribm_custom_mail_info'); $sid = $this->db->last_insert_id(MAIN_DB_PREFIX . 'sribm_custom_mail_info');
} }
foreach (array('subject' => 'subject', 'body' => 'body', 'sendto' => 'sendto_free') as $key => $item) { foreach (array('subject' => 'subject', 'body' => 'body_plaintext', 'sendto' => 'sendto_free') as $key => $item) {
if (! empty($mail_data[$key])) { if (! empty($mail_data[$key])) {
// We loop on each field. // We loop on each field.
// Not optimized, I know. // Not optimized, I know.

60
fiche-rec-tab1.php
View file

@ -56,14 +56,18 @@ do {
*/ */
// Load necessary data // Load necessary data
$object = new FactureRec($db);
$mailObject = new SRIBMCustomMailInfo($db); $mailObject = new SRIBMCustomMailInfo($db);
$form = new Form($db); $form = new Form($db);
if ($mailObject->fetch(null, $id, true) <= 0) { if ($object->fetch($id) <= 0 or !$object->id)
// Note : this should only happen when facture-rec doesn't exist or some database error. {
// If sribmcustommailinfo doesn't exist in database, we should still get a instance of the template.
setEventMessages($langs->trans("ErrorRecordNotFound"), null, 'errors'); setEventMessages($langs->trans("ErrorRecordNotFound"), null, 'errors');
break; break;
} }
if ($mailObject->fetch(null, $object->id, true) <= 0) {
setEventMessages("Weird stuff, shouldn't happen : " . $mailObject->error);
break;
}
// List of senders (user, company, robot, ...) // List of senders (user, company, robot, ...)
$listFrom = array(); $listFrom = array();
@ -88,7 +92,7 @@ do {
// Substitution array/string // Substitution array/string
$helpforsubstitution = $langs->trans('AvailableVariables').' :<br>'."\n"; $helpforsubstitution = $langs->trans('AvailableVariables').' :<br>'."\n";
$tmparray = getCommonSubstitutionArray($langs, 0, null, $mailObject->fac_rec_object); $tmparray = getCommonSubstitutionArray($langs, 0, null, $object);
complete_substitutions_array($tmparray, $langs); complete_substitutions_array($tmparray, $langs);
foreach($tmparray as $key => $val) { foreach($tmparray as $key => $val) {
$helpforsubstitution .= $key . ' -> ' . $langs->trans(dol_string_nohtmltag($val)) . '<br>'; $helpforsubstitution .= $key . ' -> ' . $langs->trans(dol_string_nohtmltag($val)) . '<br>';
@ -103,7 +107,7 @@ do {
if (GETPOST('save')) { if (GETPOST('save')) {
do { do {
// Validate input data // Validate input data
if (! array_key_exists(GETPOST('fromtype'), $listFrom)) { if (! array_key_exists(GETPOST('fromtype', 'alpha'), $listFrom)) {
setEventMessages('Unexpected from value', null, 'errors'); setEventMessages('Unexpected from value', null, 'errors');
break; break;
} }
@ -116,22 +120,18 @@ do {
break; break;
} }
// Validate some non-breaking stuff after feeding // Validate some non-breaking stuff after feeding
if (empty(GETPOST('sendto_free', 'none')) && empty(GETPOST('sendto_socpeople', 'array'))) { if (empty(GETPOST('sendto_free', 'alpha')) && empty(GETPOST('sendto_socpeople', 'array'))) {
// Kinda weird behaviour from CMailFile but better alert the user beforehand // Kinda weird behaviour from CMailFile but better alert the user beforehand
// FIXME: check if there is a workaround ? // FIXME: check if there is a workaround ?
setEventMessages("In some configuration, CMailFile doesn't allow empty 'to' recipient. You should set at least one.", null, 'warnings'); setEventMessages("In some configuration, CMailFile doesn't allow empty 'to' recipient. You should set at least one.", null, 'warnings');
//break; //break;
} }
if (! strlen(GETPOST('subject', 'none'))) { if (! strlen(GETPOST('subject', 'alpha'))) {
// Kinda weird behaviour from CMailFile but better alert the user beforehand // Kinda weird behaviour from CMailFile but better alert the user beforehand
// FIXME: check if there is a workaround ? // FIXME: check if there is a workaround ?
setEventMessages("In some configuration, CMailFile doesn't allow empty subject. You should set one.", null, 'warnings'); setEventMessages("In some configuration, CMailFile doesn't allow empty subject. You should set one.", null, 'warnings');
//break; //break;
} }
if (! in_array(GETPOST('body_ishtml', 'int'), array('-1', '0', '1'), true)) {
setEventMessages("Unexpected body_ishtml value", null, 'errors');
break;
}
// Feed the input data to the model // Feed the input data to the model
$mailObject->active = GETPOST('active', 'int') ? 1 : 0; $mailObject->active = GETPOST('active', 'int') ? 1 : 0;
@ -140,15 +140,14 @@ do {
$mailObject->fromtype = GETPOST('fromtype', 'alpha'); $mailObject->fromtype = GETPOST('fromtype', 'alpha');
$mailObject->frommail = $listFrom[$mailObject->fromtype]; $mailObject->frommail = $listFrom[$mailObject->fromtype];
$mailObject->sendto_free = GETPOST('sendto_free', 'none'); $mailObject->sendto_free = GETPOST('sendto_free', 'alpha');
$mailObject->sendto_thirdparty = in_array('thirdparty', GETPOST('sendto_socpeople', 'array')); $mailObject->sendto_thirdparty = in_array('thirdparty', GETPOST('sendto_socpeople', 'array'));
$mailObject->sendcc_free = GETPOST('sendcc_free', 'none'); $mailObject->sendcc_free = GETPOST('sendcc_free', 'alpha');
$mailObject->sendcc_thirdparty = in_array('thirdparty', GETPOST('sendcc_socpeople', 'array')); $mailObject->sendcc_thirdparty = in_array('thirdparty', GETPOST('sendcc_socpeople', 'array'));
$mailObject->subject = GETPOST('subject', 'none'); $mailObject->subject = GETPOST('subject', 'alpha');
$mailObject->body = GETPOST('body', 'none'); $mailObject->body_plaintext = GETPOST('body_plaintext', 'alpha');
$mailObject->body_ishtml = (int)GETPOST('body_ishtml', 'int');
// Save into database // Save into database
if ($mailObject->id) { if ($mailObject->id) {
@ -157,7 +156,7 @@ do {
break; break;
} }
} else { } else {
$mailObject->fk_facture_rec = $mailObject->fac_rec_object->id; $mailObject->fk_facture_rec = $object->id;
if ($mailObject->create($user) < 0) { if ($mailObject->create($user) < 0) {
setEventMessages($langs->trans("ErrorSQL") . ' : ' . $mailObject->error, null, 'errors'); setEventMessages($langs->trans("ErrorSQL") . ' : ' . $mailObject->error, null, 'errors');
break; break;
@ -226,7 +225,7 @@ do {
*/ */
// Same tabs than the main page // Same tabs than the main page
$head=invoice_rec_prepare_head($mailObject->fac_rec_object); $head=invoice_rec_prepare_head($object);
$output .= dol_get_fiche_head($head, 'sendrecurringinvoicebymail', $langs->trans("RepeatableInvoice"), -1, 'bill'); // Add a div $output .= dol_get_fiche_head($head, 'sendrecurringinvoicebymail', $langs->trans("RepeatableInvoice"), -1, 'bill'); // Add a div
$output .= '<div class="inline-block floatleft valignmiddle refid refidpadding">' . $mailObject->fac_rec_object->ref . "</div>\n"; $output .= '<div class="inline-block floatleft valignmiddle refid refidpadding">' . $mailObject->fac_rec_object->ref . "</div>\n";
$output .= '<div class="refidno">' . $langs->trans('ThirdParty') . ' : ' . $mailObject->fac_rec_object->thirdparty->getNomUrl(1) . "</div>\n"; $output .= '<div class="refidno">' . $langs->trans('ThirdParty') . ' : ' . $mailObject->fac_rec_object->thirdparty->getNomUrl(1) . "</div>\n";
@ -234,12 +233,6 @@ do {
$output .= '<div class="titre inline-block">' . $langs->trans("Options") . "</div>\n"; $output .= '<div class="titre inline-block">' . $langs->trans("Options") . "</div>\n";
$output .= '<form id="sribmform" name="sribmform" method="POST" action="#sribmform">'; $output .= '<form id="sribmform" name="sribmform" method="POST" action="#sribmform">';
if (function_exists('newToken')) {
$output .= '<input type="hidden" name="token" value="'.newToken().'">'; // CSRF protection
} else {
// Used before Dolibar 13
$output .= '<input type="hidden" name="token" value="'.$_SESSION['newtoken'].'">'; // CSRF protection
}
$output .= '<table class="liste" summary="mail options"><tbody>'; $output .= '<table class="liste" summary="mail options"><tbody>';
$output .= '<tr class="oddeven">'; $output .= '<tr class="oddeven">';
$output .= ' <td><label for="active">' . $langs->trans('OptionEnable') . "</label></td>\n"; $output .= ' <td><label for="active">' . $langs->trans('OptionEnable') . "</label></td>\n";
@ -302,7 +295,7 @@ do {
$output .= '<td><input type="checkbox" name="addmaindocfile" value="1"' . ($tmp_addmaindocfile ? ' checked="checked"' : '') . ' /> ' . $langs->trans("JoinMainDoc") . "</td>\n"; $output .= '<td><input type="checkbox" name="addmaindocfile" value="1"' . ($tmp_addmaindocfile ? ' checked="checked"' : '') . ' /> ' . $langs->trans("JoinMainDoc") . "</td>\n";
// body // body_plaintext
$output .= '<tr><td class="minwidth200" valign="top">'; $output .= '<tr><td class="minwidth200" valign="top">';
$output .= $form->textwithpicto($langs->trans("MailText"), $helpforsubstitution, 1, 'help', '', 0, 2, 'substittooltipfrombody'); $output .= $form->textwithpicto($langs->trans("MailText"), $helpforsubstitution, 1, 'help', '', 0, 2, 'substittooltipfrombody');
$output .= "</td>\n<td>"; $output .= "</td>\n<td>";
@ -313,24 +306,11 @@ do {
$doleditor = new DolEditor('body_plaintext', (GETPOST('body_plaintext', 'alpha') ? GETPOST('body_plaintext', 'alpha') : $mailObject->body_plaintext), '', 280); $doleditor = new DolEditor('body_plaintext', (GETPOST('body_plaintext', 'alpha') ? GETPOST('body_plaintext', 'alpha') : $mailObject->body_plaintext), '', 280);
$output .= $doleditor->Create(1); $output .= $doleditor->Create(1);
*/ */
$output .= '<textarea id="body" name="body" rows="14" cols="80" class="flat">'; $output .= '<textarea id="body_plaintext" name="body_plaintext" rows="14" cols="80" class="flat">';
$output .= htmlentities(GETPOST('body', 'alpha') ? GETPOST('body', 'alpha') : $mailObject->body); $output .= htmlentities(GETPOST('body_plaintext', 'alpha') ? GETPOST('body_plaintext', 'alpha') : $mailObject->body_plaintext);
$output .= "</textarea>\n"; $output .= "</textarea>\n";
$output .= "</td></tr>\n"; $output .= "</td></tr>\n";
// body_ishtml
$output .= '<tr><td>' . $langs->trans('MailBodyFormat') . "</td>\n";
$tmp_ishtml = (int)(GETPOSTISSET('body_ishtml') ? GETPOST('body_ishtml', 'int') : $mailObject->body_ishtml);
// selectarray() does funny things with -1 key, so we build it manually.
//$output .= $form->selectarray('body_ishtml', $listBodyIsHtml, $mailObject->body_ishtml);
$output .= '<td><select name="body_ishtml">';
foreach (array(-1 => 'MailBodyFormatAutoDetect', 0 => 'MailBodyFormatPlainText', 1 => 'MailBodyFormatHtml') as $key => $item) {
$output .= '<option value="' . $key . '"';
$output .= ($key === $tmp_ishtml) ? ' selected="selected"' : '';
$output .= '>' . $langs->trans($item) . "</option>\n";
}
$output .= "</select>\n</td>\n";
$output .= "</table>\n"; $output .= "</table>\n";
$output .= '<br><div class="center">'; $output .= '<br><div class="center">';

13
langs/en_US/sendrecurringinvoicebymail.lang
View file

@ -28,9 +28,10 @@ ModulesendrecurringinvoicebymailDesc = Send FactureRec generated invoices by mai
sendrecurringinvoicebymailSetup = sendrecurringinvoicebymail setup sendrecurringinvoicebymailSetup = sendrecurringinvoicebymail setup
Settings = Settings Settings = Settings
sendrecurringinvoicebymailSetupPage = sendrecurringinvoicebymail setup page sendrecurringinvoicebymailSetupPage = sendrecurringinvoicebymail setup page
NoticeCronIsDisabled = Notice: the cron / Scheduled Jobs module seems disabled. Unless you know what you are doing, invoices won't be generated and emails won't be sent. SENDRECURRINGINVOICEBYMAIL_MYPARAM1 = My param 1
SENDRECURRINGINVOICEBYMAIL_BODY_ISHTML_DEFAULT = Default mail body's format SENDRECURRINGINVOICEBYMAIL_MYPARAM1Tooltip = My param 1 tooltip
SENDRECURRINGINVOICEBYMAIL_BODY_ISHTML_DEFAULTTooltip = -1 for auto-detect, 0 for plaintext, 1 for HTML SENDRECURRINGINVOICEBYMAIL_MYPARAM2=My param 2
SENDRECURRINGINVOICEBYMAIL_MYPARAM2Tooltip=My param 2 tooltip
# #
@ -40,16 +41,10 @@ About = About
sendrecurringinvoicebymailAbout = About sendrecurringinvoicebymail sendrecurringinvoicebymailAbout = About sendrecurringinvoicebymail
sendrecurringinvoicebymailAboutPage = sendrecurringinvoicebymail about page sendrecurringinvoicebymailAboutPage = sendrecurringinvoicebymail about page
#
# Tab title on the fiche-rec page # Tab title on the fiche-rec page
#
CustomizationTitle = Customization CustomizationTitle = Customization
CustomizationIntro = Below, you can override the global email template for this particular recurring invoice. To remove all customization, click on the %s button. CustomizationIntro = Below, you can override the global email template for this particular recurring invoice. To remove all customization, click on the %s button.
CustomizationLinkToGlobalTemplate = As a note, the global email template can be <a href="%s">configured here</a>, and the default sender address can be <a href="%s">configured there</a>. CustomizationLinkToGlobalTemplate = As a note, the global email template can be <a href="%s">configured here</a>, and the default sender address can be <a href="%s">configured there</a>.
MailBodyFormat = Message format
MailBodyFormatAutoDetect = Auto-detect
MailBodyFormatPlainText = Plain text
MailBodyFormatHtml = HTML
OptionEnable = Send mail when generating via cron (cf. module "Scheduled Jobs") OptionEnable = Send mail when generating via cron (cf. module "Scheduled Jobs")
Reset = Reset Reset = Reset
ResetDone = Reset done : customization deleted ResetDone = Reset done : customization deleted

8
langs/fr_FR/sendrecurringinvoicebymail.lang
View file

@ -28,10 +28,6 @@ ModulesendrecurringinvoicebymailDesc = Envoi par mail des factures générées p
sendrecurringinvoicebymailSetup = Configuration du module sendrecurringinvoicebymail sendrecurringinvoicebymailSetup = Configuration du module sendrecurringinvoicebymail
Settings = Réglages Settings = Réglages
sendrecurringinvoicebymailSetupPage = Page de configuration du module sendrecurringinvoicebymail sendrecurringinvoicebymailSetupPage = Page de configuration du module sendrecurringinvoicebymail
NoticeCronIsDisabled = Notice : le module cron / Travaux Planifiés semble désactivé. Sauf cas particulier, les factures ne seront pas générées et les mails ne seront pas envoyés.
SENDRECURRINGINVOICEBYMAIL_BODY_ISHTML_DEFAULT = Format par défaut du corps du mail
SENDRECURRINGINVOICEBYMAIL_BODY_ISHTML_DEFAULTTooltip = -1: auto-détection, 0: texte pur, 1: HTML
# #
# Page À propos # Page À propos
@ -46,10 +42,6 @@ sendrecurringinvoicebymailAboutPage = Page à propos de sendrecurringinvoicebyma
CustomizationTitle = Personnalisation CustomizationTitle = Personnalisation
CustomizationIntro = Ci-dessous, vous pouvez personnaliser les emails pour cette facture-modèle. Pour annuler toute personnalisation, cliquez sur le bouton '%s'. CustomizationIntro = Ci-dessous, vous pouvez personnaliser les emails pour cette facture-modèle. Pour annuler toute personnalisation, cliquez sur le bouton '%s'.
CustomizationLinkToGlobalTemplate = Pour mémoire, le template global est <a href="%s">configurable par ici</a>, et l'adresse de l'émetteur par défaut est <a href="%s">configurable par là</a>. CustomizationLinkToGlobalTemplate = Pour mémoire, le template global est <a href="%s">configurable par ici</a>, et l'adresse de l'émetteur par défaut est <a href="%s">configurable par là</a>.
MailBodyFormat = Format du message
MailBodyFormatAutoDetect = Auto-detect
MailBodyFormatPlainText = Texte pur
MailBodyFormatHtml = HTML
OptionEnable = Envoyer par email lors d'une génération automatique via le module "Travaux planifiés" OptionEnable = Envoyer par email lors d'une génération automatique via le module "Travaux planifiés"
Reset = Réinitialiser Reset = Réinitialiser
ResetDone = Réinitialisation effectuée : personnalisation supprimée. ResetDone = Réinitialisation effectuée : personnalisation supprimée.

21
sql/update_0.3.1-0.3.2.sql
View file

@ -1,21 +0,0 @@
-- Copyright (C) 2021 Chl <chl-dev@bugness.org>
--
-- This program is free software: you can redistribute it and/or modify
-- it under the terms of the GNU General Public License as published by
-- the Free Software Foundation, either version 3 of the License, or
-- (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-- GNU General Public License for more details.
--
-- You should have received a copy of the GNU General Public License
-- along with this program. If not, see http://www.gnu.org/licenses/.
-- We designed the schema too quickly : CMailFile doesn't let us manage
-- independently the text and html parts. All we can do is set the mode.
ALTER TABLE llx_sribm_custom_mail_info CHANGE COLUMN body_plaintext body mediumtext;
ALTER TABLE llx_sribm_custom_mail_info DROP COLUMN body_html;
ALTER TABLE llx_sribm_custom_mail_info ADD COLUMN body_ishtml smallint DEFAULT 0 NOT NULL;