* Copyright (C) 2024 MDW * * 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 . */ /** * \file partnership/class/partnershiputils.class.php * \ingroup partnership * \brief Class with utilities */ //require_once(DOL_DOCUMENT_ROOT."/core/class/commonobject.class.php"); //require_once(DOL_DOCUMENT_ROOT."/societe/class/societe.class.php"); require_once DOL_DOCUMENT_ROOT.'/comm/action/class/actioncomm.class.php'; require_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php'; require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php'; require_once DOL_DOCUMENT_ROOT.'/core/lib/geturl.lib.php'; require_once DOL_DOCUMENT_ROOT.'/partnership/lib/partnership.lib.php'; require_once DOL_DOCUMENT_ROOT.'/partnership/class/partnership.class.php'; require_once DOL_DOCUMENT_ROOT.'/societe/class/societe.class.php'; require_once DOL_DOCUMENT_ROOT.'/adherents/class/adherent.class.php'; /** * Class with cron tasks of Partnership module */ class PartnershipUtils { /** * @var DoliDB */ public $db; //!< To store db handler /** * @var string */ public $error; //!< To return error code (or message) /** * @var string[] */ public $errors = array(); //!< To return several error codes (or messages) /** * @var string To store output of some cron methods */ public $output; /** * Constructor * * @param DoliDB $db Database handler */ public function __construct($db) { $this->db = $db; } /** * Action executed by scheduler to cancel status of partnership when subscription is expired + x days. (Max number of action batch per call = $conf->global->PARTNERSHIP_MAX_EXPIRATION_CANCEL_PER_CALL) * * CAN BE A CRON TASK * * @return int 0 if OK, <>0 if KO (this function is used also by cron so only 0 is OK) */ public function doCancelStatusOfMemberPartnership() { global $conf, $langs, $user; $managedfor = getDolGlobalString('PARTNERSHIP_IS_MANAGED_FOR', 'thirdparty'); if ($managedfor != 'member') { return 0; // If option 'PARTNERSHIP_IS_MANAGED_FOR' = 'thirdparty', this cron job does nothing. } $partnership = new Partnership($this->db); $MAXPERCALL = (!getDolGlobalString('PARTNERSHIP_MAX_EXPIRATION_CANCEL_PER_CALL') ? 25 : $conf->global->PARTNERSHIP_MAX_EXPIRATION_CANCEL_PER_CALL); // Limit to 25 per call $langs->loadLangs(array("partnership", "member")); $error = 0; $erroremail = ''; $this->output = ''; $this->error = ''; $partnershipsprocessed = array(); $gracedelay = getDolGlobalString('PARTNERSHIP_NBDAYS_AFTER_MEMBER_EXPIRATION_BEFORE_CANCEL'); if ($gracedelay < 1) { $this->error = 'BadValueForDelayBeforeCancelCheckSetup'; return -1; } dol_syslog(get_class($this)."::doCancelStatusOfMemberPartnership cancel expired partnerships with grace delay of ".$gracedelay); $now = dol_now(); $datetotest = dol_time_plus_duree($now, -1 * abs((float) $gracedelay), 'd'); $this->db->begin(); $sql = "SELECT p.rowid, p.fk_member, p.status"; $sql .= ", d.datefin, d.fk_adherent_type, dty.subscription"; $sql .= " FROM ".MAIN_DB_PREFIX."partnership as p"; $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."adherent as d on (d.rowid = p.fk_member)"; $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."adherent_type as dty on (dty.rowid = d.fk_adherent_type)"; $sql .= " WHERE fk_member > 0"; $sql .= " AND (d.datefin < '".$this->db->idate($datetotest)."' AND dty.subscription = 1)"; $sql .= " AND p.status = ".((int) $partnership::STATUS_APPROVED); // Only accepted not yet canceled $sql .= $this->db->order('d.rowid', 'ASC'); // Limit is managed into loop later $numofexpiredmembers = 0; $resql = $this->db->query($sql); if ($resql) { $numofexpiredmembers = $this->db->num_rows($resql); $somethingdoneonpartnership = 0; $ifetchpartner = 0; while ($ifetchpartner < $numofexpiredmembers) { $ifetchpartner++; $obj = $this->db->fetch_object($resql); if ($obj) { if (!empty($partnershipsprocessed[$obj->rowid])) { continue; } if ($somethingdoneonpartnership >= $MAXPERCALL) { dol_syslog("We reach the limit of ".$MAXPERCALL." partnership processed, so we quit loop for this batch doCancelStatusOfMemberPartnership to avoid to reach email quota.", LOG_WARNING); break; } $object = new Partnership($this->db); $object->fetch($obj->rowid); // Get expiration date $expirationdate = $obj->datefin; if ($expirationdate && $expirationdate < $now) { // If contract expired (we already had a test into main select, this is a security) $somethingdoneonpartnership++; $result = $object->cancel($user, 0); // $conf->global->noapachereload = null; if ($result < 0) { $error++; $this->error = $object->error; if (is_array($object->errors) && count($object->errors)) { if (is_array($this->errors)) { $this->errors = array_merge($this->errors, $object->errors); } else { $this->errors = $object->errors; } } } else { $partnershipsprocessed[$object->id] = $object->ref; // Send an email to inform member $labeltemplate = '('.getDolGlobalString('PARTNERSHIP_SENDMAIL_IF_AUTO_CANCEL', 'SendingEmailOnPartnershipCanceled').')'; dol_syslog("Now we will send an email to member id=".$object->fk_member." with label ".$labeltemplate); // Send deployment email include_once DOL_DOCUMENT_ROOT.'/core/class/html.formmail.class.php'; include_once DOL_DOCUMENT_ROOT.'/core/class/CMailFile.class.php'; $formmail = new FormMail($this->db); // Define output language $outputlangs = $langs; $newlang = ''; if (getDolGlobalInt('MAIN_MULTILANGS') && empty($newlang) && GETPOST('lang_id', 'aZ09')) { $newlang = GETPOST('lang_id', 'aZ09'); } if (!empty($newlang)) { $outputlangs = new Translate("", $conf); $outputlangs->setDefaultLang($newlang); $outputlangs->loadLangs(array('main', 'member', 'partnership')); } $arraydefaultmessage = $formmail->getEMailTemplate($this->db, 'partnership_send', $user, $outputlangs, 0, 1, $labeltemplate); $substitutionarray = getCommonSubstitutionArray($outputlangs, 0, null, $object); complete_substitutions_array($substitutionarray, $outputlangs, $object); $subject = make_substitutions($arraydefaultmessage->topic, $substitutionarray, $outputlangs); $msg = make_substitutions($arraydefaultmessage->content, $substitutionarray, $outputlangs); $from = dol_string_nospecial($conf->global->MAIN_INFO_SOCIETE_NOM, ' ', array(",")).' <' . getDolGlobalString('MAIN_INFO_SOCIETE_MAIL').'>'; // We are in the case of autocancellation subscription because of missing backlink $fk_partner = $object->fk_member; $adherent = new Adherent($this->db); $adherent->fetch($object->fk_member); $sendto = $adherent->email; $trackid = 'par'.$object->id; $sendcontext = 'standard'; $cmail = new CMailFile($subject, $sendto, $from, $msg, array(), array(), array(), '', '', 0, 1, '', '', $trackid, '', $sendcontext); $result = $cmail->sendfile(); if (!$result || !empty($cmail->error) || !empty($cmail->errors)) { $erroremail .= ($erroremail ? ', ' : '').$cmail->error; $this->errors[] = $cmail->error; if (is_array($cmail->errors) && count($cmail->errors) > 0) { $this->errors += $cmail->errors; } } else { // Initialisation of datas of object to call trigger if (is_object($object)) { $actiontypecode = 'AC_OTH_AUTO'; // Event insert into agenda automatically $attachedfiles = array(); $object->actiontypecode = $actiontypecode; // Type of event ('AC_OTH', 'AC_OTH_AUTO', 'AC_XXX'...) $object->actionmsg = $arraydefaultmessage->topic."\n".$arraydefaultmessage->content; // Long text $object->actionmsg2 = $langs->transnoentities("PartnershipSentByEMail", $object->ref); ; // Short text ($langs->transnoentities('MailSentByTo')...); if (getDolGlobalString('MAIN_MAIL_REPLACE_EVENT_TITLE_BY_EMAIL_SUBJECT')) { $object->actionmsg2 = $subject; // Short text } $object->trackid = $trackid; $object->fk_element = $object->id; $object->elementtype = $object->element; if (is_array($attachedfiles) && count($attachedfiles) > 0) { $object->attachedfiles = $attachedfiles; } $object->email_from = $from; $object->email_subject = $subject; $object->email_to = $sendto; $object->email_subject = $subject; $triggersendname = 'PARTNERSHIP_SENTBYMAIL'; // Call of triggers (you should have set $triggersendname to execute trigger) if (!empty($triggersendname)) { $result = $object->call_trigger($triggersendname, $user); if ($result < 0) { $error++; } } // End call of triggers } } } } } } } else { $error++; $this->error = $this->db->lasterror(); } if (!$error) { $this->db->commit(); $this->output = $numofexpiredmembers.' expired partnership members found'."\n"; if ($erroremail) { $this->output .= '. Got errors when sending some email : '.$erroremail; } } else { $this->db->rollback(); $this->output = "Rollback after error\n"; $this->output .= $numofexpiredmembers.' expired partnership members found'."\n"; if ($erroremail) { $this->output .= '. Got errors when sending some email : '.$erroremail; } } return ($error ? 1 : 0); } /** * Action executed by scheduler to check if Dolibarr backlink not found on partner website. (Max number of action batch per call = $conf->global->PARTNERSHIP_MAX_WARNING_BACKLINK_PER_CALL) * * CAN BE A CRON TASK * * @param int $maxpercall Max per call * @return int 0 if OK, <>0 if KO (this function is used also by cron so only 0 is OK) */ public function doWarningOfPartnershipIfDolibarrBacklinkNotfound($maxpercall = 0) { global $conf, $langs, $user; $managedfor = getDolGlobalString('PARTNERSHIP_IS_MANAGED_FOR'); $partnership = new Partnership($this->db); if (empty($maxpercall)) { $maxpercall = getDolGlobalInt('PARTNERSHIP_MAX_WARNING_BACKLINK_PER_CALL', 10); } $langs->loadLangs(array("partnership", "member")); $error = 0; $erroremail = ''; $this->output = ''; $this->error = ''; $partnershipsprocessed = array(); $emailnotfound = ''; $websitenotfound = ''; /*$gracedelay = getDolGlobalInt('PARTNERSHIP_NBDAYS_AFTER_MEMBER_EXPIRATION_BEFORE_CANCEL'); if ($gracedelay < 1) { $this->error = 'BadValueForDelayBeforeCancelCheckSetup'; return -1; }*/ $fk_partner = ($managedfor == 'member') ? 'fk_member' : 'fk_soc'; dol_syslog(get_class($this)."::doWarningOfPartnershipIfDolibarrBacklinkNotfound Warning of partnership"); $now = dol_now(); //$datetotest = dol_time_plus_duree($now, -1 * abs($gracedelay), 'd'); $this->db->begin(); $sql = "SELECT p.rowid, p.status, p.".$fk_partner; $sql .= ", p.url_to_check, p.last_check_backlink"; $sql .= ', partner.url, partner.email'; $sql .= " FROM ".MAIN_DB_PREFIX."partnership as p"; if ($managedfor == 'member') { $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."adherent as partner on (partner.rowid = p.fk_member)"; } else { $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."societe as partner on (partner.rowid = p.fk_soc)"; } $sql .= " WHERE p.".$fk_partner." > 0"; $sql .= " AND p.status = ".((int) $partnership::STATUS_APPROVED); // Only accepted and not yet canceled $sql .= " AND (p.last_check_backlink IS NULL OR p.last_check_backlink <= '".$this->db->idate($now - 24 * 3600)."')"; // Never more than 1 check every day to check that website contains a referral link. $sql .= $this->db->order('p.rowid', 'ASC'); // Limit is managed into loop later $numofexpiredmembers = 0; $resql = $this->db->query($sql); if ($resql) { $numofexpiredmembers = $this->db->num_rows($resql); $somethingdoneonpartnership = 0; $ifetchpartner = 0; while ($ifetchpartner < $numofexpiredmembers) { $ifetchpartner++; $obj = $this->db->fetch_object($resql); if ($obj) { if (!empty($partnershipsprocessed[$obj->rowid])) { continue; } if ($somethingdoneonpartnership >= $maxpercall) { dol_syslog("We reach the limit of ".$maxpercall." partnership processed, so we quit loop for this batch doWarningOfPartnershipIfDolibarrBacklinkNotfound to avoid to reach email quota.", LOG_WARNING); break; } $backlinkfound = 0; $object = new Partnership($this->db); $object->fetch($obj->rowid); if ($managedfor == 'member') { $fk_partner = $object->fk_member; } else { $fk_partner = $object->fk_soc; } $website = (empty($obj->url_to_check) ? $obj->url : $obj->url_to_check); if (empty($website)) { $websitenotfound .= ($websitenotfound ? ', ' : '').'Website not found for id="'.$fk_partner.'"'."\n"; } else { $backlinkfound = $this->checkDolibarrBacklink($website); } if (!$backlinkfound) { $tmpcount = $object->count_last_url_check_error + 1; $nbminbacklinkerrorforcancel = (int) getDolGlobalString('PARTNERSHIP_MIN_BACKLINK_ERROR_FOR_CANCEL', 3); $nbmaxbacklinkerrorforcancel = (int) getDolGlobalString('PARTNERSHIP_MAX_BACKLINK_ERROR_FOR_CANCEL', (int) $nbminbacklinkerrorforcancel + 2); // If $nbminbacklinkerrorforemail = 0, no autoemail if ($nbminbacklinkerrorforcancel > 0) { if ($tmpcount > $nbminbacklinkerrorforcancel && $tmpcount <= $nbmaxbacklinkerrorforcancel) { // Send Warning Email if (!empty($obj->email)) { $emailnotfound .= ($emailnotfound ? ', ' : '').'Email not found for id="'.$fk_partner.'"'."\n"; } else { // Example: 'SendingEmailOnPartnershipWillSoonBeCanceled' $labeltemplate = '('.getDolGlobalString('PARTNERSHIP_SENDMAIL_IF_NO_LINK', 'SendingEmailOnPartnershipWillSoonBeCanceled').')'; dol_syslog("Now we will send an email to partner id=".$fk_partner." with label ".$labeltemplate); // Send deployment email include_once DOL_DOCUMENT_ROOT.'/core/class/html.formmail.class.php'; include_once DOL_DOCUMENT_ROOT.'/core/class/CMailFile.class.php'; $formmail = new FormMail($this->db); // Define output language $outputlangs = $langs; $newlang = ''; if (getDolGlobalInt('MAIN_MULTILANGS') && empty($newlang) && GETPOST('lang_id', 'aZ09')) { $newlang = GETPOST('lang_id', 'aZ09'); } if (!empty($newlang)) { $outputlangs = new Translate("", $conf); $outputlangs->setDefaultLang($newlang); $outputlangs->loadLangs(array('main', 'member', 'partnership')); } $arraydefaultmessage = $formmail->getEMailTemplate($this->db, 'partnership_send', $user, $outputlangs, 0, 1, $labeltemplate); $substitutionarray = getCommonSubstitutionArray($outputlangs, 0, null, $object); complete_substitutions_array($substitutionarray, $outputlangs, $object); $subject = make_substitutions($arraydefaultmessage->topic, $substitutionarray, $outputlangs); $msg = make_substitutions($arraydefaultmessage->content, $substitutionarray, $outputlangs); $from = dol_string_nospecial($conf->global->MAIN_INFO_SOCIETE_NOM, ' ', array(",")).' <' . getDolGlobalString('MAIN_INFO_SOCIETE_MAIL').'>'; $sendto = $obj->email; $trackid = 'par'.$object->id; $sendcontext = 'standard'; $cmail = new CMailFile($subject, $sendto, $from, $msg, array(), array(), array(), '', '', 0, 1, '', '', $trackid, '', $sendcontext); $result = $cmail->sendfile(); if (!$result || !empty($cmail->error) || !empty($cmail->errors)) { $erroremail .= ($erroremail ? ', ' : '').$cmail->error; $this->errors[] = $cmail->error; if (is_array($cmail->errors) && count($cmail->errors) > 0) { $this->errors += $cmail->errors; } } else { // Initialisation of datas of object to call trigger if (is_object($object)) { $actiontypecode = 'AC_OTH_AUTO'; // Event insert into agenda automatically $attachedfiles = array(); if ($managedfor != 'member') { $object->socid = $fk_partner; // To link to a company } $object->actiontypecode = $actiontypecode; // Type of event ('AC_OTH', 'AC_OTH_AUTO', 'AC_XXX'...) $object->actionmsg = $arraydefaultmessage->topic."\n".$arraydefaultmessage->content; // Long text $object->actionmsg2 = $langs->transnoentities("PartnershipSentByEMail", $object->ref); ; // Short text ($langs->transnoentities('MailSentByTo')...); if (getDolGlobalString('MAIN_MAIL_REPLACE_EVENT_TITLE_BY_EMAIL_SUBJECT')) { $object->actionmsg2 = $subject; // Short text } $object->trackid = $trackid; $object->fk_element = $object->id; $object->elementtype = $object->element; if (is_array($attachedfiles) && count($attachedfiles) > 0) { $object->attachedfiles = $attachedfiles; } $object->email_from = $from; $object->email_subject = $subject; $object->email_to = $sendto; $object->email_subject = $subject; $triggersendname = 'PARTNERSHIP_SENTBYMAIL'; // Call of triggers (you should have set $triggersendname to execute trigger) if (!empty($triggersendname)) { $result = $object->call_trigger($triggersendname, $user); if ($result < 0) { $error++; } } // End call of triggers } } } } elseif ($tmpcount > $nbmaxbacklinkerrorforcancel) { // Cancel Partnership $object->status = $object::STATUS_CANCELED; $object->reason_decline_or_cancel = $langs->trans('BacklinkNotFoundOnPartnerWebsite'); } } $object->count_last_url_check_error = $tmpcount; } else { $object->count_last_url_check_error = 0; $object->reason_decline_or_cancel = ''; } $partnershipsprocessed[$object->id] = $object->ref; $object->last_check_backlink = $now; $object->update($user); } } } else { $error++; $this->error = $this->db->lasterror(); } if (!$error) { $this->db->commit(); $this->output = ""; } else { $this->db->rollback(); $this->output = "Rollback after error\n"; } $this->output .= $numofexpiredmembers.' partnership checked'."\n"; if ($erroremail) { $this->output .= '. Got errors when sending some email : '.$erroremail."\n"; } if ($emailnotfound) { $this->output .= '. Email not found for some partner : '.$emailnotfound."\n"; } if ($websitenotfound) { $this->output .= '. Website not found for some partner : '.$websitenotfound."\n"; } $this->output .= "\nSQL used to find partnerships to scan: ".$sql; return ($error ? 1 : 0); } /** * Action to check if Dolibarr backlink not found on partner website * * @param string $website Partner's website URL * @return int 0 if KO, 1 if OK */ private function checkDolibarrBacklink($website = null) { global $conf; $found = 0; $error = 0; $webcontent = ''; // $website = 'https://nextgestion.com/'; // For Test $tmpgeturl = getURLContent($website, 'GET', '', 1, array(), array('http', 'https'), 0); if ($tmpgeturl['curl_error_no']) { $error++; dol_syslog('Error getting '.$website.': '.$tmpgeturl['curl_error_msg']); } elseif ($tmpgeturl['http_code'] != '200') { $error++; dol_syslog('Error getting '.$website.': '.$tmpgeturl['curl_error_msg']); } else { $urlContent = $tmpgeturl['content']; $dom = new DOMDocument(); @$dom->loadHTML($urlContent); $xpath = new DOMXPath($dom); $hrefs = $xpath->evaluate("//a"); '@phan-var-force DOMNodeList $hrefs'; for ($i = 0; $i < $hrefs->length; $i++) { $href = $hrefs->item($i); '@phan-var-force DOMElement $href'; $url = $href->getAttribute('href'); $url = filter_var($url, FILTER_SANITIZE_URL); if (!(!filter_var($url, FILTER_VALIDATE_URL))) { $webcontent .= $url; } } } if ($webcontent && getDolGlobalString('PARTNERSHIP_BACKLINKS_TO_CHECK') && preg_match('/' . getDolGlobalString('PARTNERSHIP_BACKLINKS_TO_CHECK').'/', $webcontent)) { $found = 1; } return $found; } }