Fetched upstream changes

Raza403 · Raza403 · commit dd5cfd69832f · 2025-07-20T20:15:33.000+05:00
diff --git a/backup/moodle2/backup_customcert_stepslib.php b/backup/moodle2/backup_customcert_stepslib.php
@@ -40,8 +40,10 @@ protected function define_structure() {
 
         // The instance.
         $customcert = new backup_nested_element('customcert', ['id'], [
-            'templateid', 'name', 'intro', 'introformat', 'requiredtime', 'verifyany', 'emailstudents',
-            'emailteachers', 'emailothers', 'protection', 'timecreated', 'timemodified']);
+            'templateid', 'name', 'intro', 'introformat', 'requiredtime', 'verifyany',
+            'deliveryoption', 'usecustomfilename', 'customfilenamepattern', 'emailstudents',
+            'emailteachers', 'emailothers', 'protection', 'language', 'timecreated',
+            'timemodified']);
 
         // The template.
         $template = new backup_nested_element('template', ['id'], [
diff --git a/classes/task/issue_certificates_task.php b/classes/task/issue_certificates_task.php
@@ -56,10 +56,8 @@ public function execute() {
         if ($CFG->dbtype === 'oci') {
             // For Oracle, convert the CLOB to a VARCHAR2 (limiting to 4000 characters) since we are using DISTINCT.
             $emailothersselect = "DBMS_LOB.SUBSTR(c.emailothers, 4000, 1) AS emailothers";
-            $emailotherslengthsql = "DBMS_LOB.GETLENGTH(c.emailothers)";
         } else {
             $emailothersselect = "c.emailothers";
-            $emailotherslengthsql = $DB->sql_length('c.emailothers');
         }
 
         $emailotherslengthsql = $DB->sql_length('c.emailothers');
diff --git a/classes/template.php b/classes/template.php
@@ -314,24 +314,75 @@ public function generate_pdf(bool $preview = false, ?int $userid = null, bool $r
                 $deliveryoption = $customcert->deliveryoption;
             }
 
-            // Remove full-stop at the end, if it exists, to avoid "..pdf" being created and being filtered by clean_filename.
-            $filename = rtrim(format_string($this->name, true, ['context' => $this->get_context()]), '.');
-
+            // Set up PDF document properties — no header/footer, auto page break.
             $pdf->setPrintHeader(false);
             $pdf->setPrintFooter(false);
-            $pdf->SetTitle($filename);
             $pdf->SetAutoPageBreak(true, 0);
 
+            // Get filename pattern from global settings.
+            if (empty($customcert->usecustomfilename) || empty($customcert->customfilenamepattern)) {
+                // Use the custom cert name as the base filename (strip any trailing dot).
+                $filename = rtrim(format_string($this->name, true, ['context' => $this->get_context()]), '.');
+            } else {
+                // Get issue record for date (if issued); fallback to current date if not found.
+                $issue = $DB->get_record('customcert_issues', [
+                    'userid' => $user->id,
+                    'customcertid' => $customcert->id,
+                ]);
+
+                if ($issue && !empty($issue->timecreated)) {
+                    $issuedate = date('Y-m-d', $issue->timecreated);
+                } else {
+                    $issuedate = date('Y-m-d');
+                }
+
+                $course = $DB->get_record('course', ['id' => $customcert->course]);
+
+                $values = [
+                    '{FIRST_NAME}' => $user->firstname ?? '',
+                    '{LAST_NAME}' => $user->lastname ?? '',
+                    '{COURSE_SHORT_NAME}' => $course ? $course->shortname : '',
+                    '{COURSE_FULL_NAME}' => $course ? $course->fullname : '',
+                    '{ISSUE_DATE}' => $issuedate,
+                ];
+
+                // Handle group if needed.
+                $groups = groups_get_all_groups($course->id, $user->id);
+                if (!empty($groups)) {
+                    $groupnames = array_map(function($g) {
+                        return $g->name;
+                    }, $groups);
+                    $values['{GROUP_NAME}'] = implode(', ', $groupnames);
+                } else {
+                    $values['{GROUP_NAME}'] = '';
+                }
+
+                // Replace placeholders with actual values.
+                $filename = strtr($customcert->customfilenamepattern, $values);
+
+                // Remove trailing dot to avoid "..pdf" issues.
+                $filename = rtrim($filename, '.');
+            }
+
             // This is the logic the TCPDF library uses when processing the name. This makes names
             // such as 'الشهادة' become empty, so set a default name in these cases.
             $filename = preg_replace('/[\s]+/', '_', $filename);
             $filename = preg_replace('/[^a-zA-Z0-9_\.-]/', '', $filename);
 
+            // If filename ends up empty (e.g. after removing unsupported characters), use default string.
             if (empty($filename)) {
                 $filename = get_string('certificate', 'customcert');
             }
 
+            // Remove existing ".pdf" extension if present to avoid duplication.
+            $filename = preg_replace('/\.pdf$/i', '', $filename);
+
+            // Clean the final filename and append ".pdf".
             $filename = clean_filename($filename . '.pdf');
+
+            // Set the PDF document title (for metadata, not the filename itself).
+            $pdf->SetTitle($filename);
+
             // Loop through the pages and display their content.
             foreach ($pages as $page) {
                 // Add the page to the PDF.
diff --git a/db/install.xml b/db/install.xml
@@ -15,6 +15,8 @@
         <FIELD NAME="requiredtime" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
         <FIELD NAME="verifyany" TYPE="int" LENGTH="1" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
         <FIELD NAME="deliveryoption" TYPE="char" LENGTH="255" NOTNULL="false" SEQUENCE="false"/>
+        <FIELD NAME="usecustomfilename" TYPE="int" LENGTH="1" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
+        <FIELD NAME="customfilenamepattern" TYPE="text" NOTNULL="false" SEQUENCE="false"/>
         <FIELD NAME="emailstudents" TYPE="int" LENGTH="1" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
         <FIELD NAME="emailteachers" TYPE="int" LENGTH="1" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
         <FIELD NAME="emailothers" TYPE="text" NOTNULL="false" SEQUENCE="false"/>
diff --git a/db/upgrade.php b/db/upgrade.php
@@ -318,5 +318,24 @@ function xmldb_customcert_upgrade($oldversion) {
         upgrade_plugin_savepoint(true, 2024042210, 'mod', 'customcert');
     }
 
+    if ($oldversion < 2024042213) {
+        $table = new xmldb_table('customcert');
+
+        // Add 'usecustomfilename' field.
+        $field = new xmldb_field('usecustomfilename', XMLDB_TYPE_INTEGER, '1', null, XMLDB_NOTNULL, null, '0', 'deliveryoption');
+        if (!$dbman->field_exists($table, $field)) {
+            $dbman->add_field($table, $field);
+        }
+
+        // Add 'customfilenamepattern' field.
+        $field = new xmldb_field('customfilenamepattern', XMLDB_TYPE_TEXT, null, null, null, null, null, 'usecustomfilename');
+        if (!$dbman->field_exists($table, $field)) {
+            $dbman->add_field($table, $field);
+        }
+
+        // Savepoint reached.
+        upgrade_mod_savepoint(true, 2024042213, 'customcert');
+    }
+
     return true;
 }
diff --git a/lang/en/customcert.php b/lang/en/customcert.php
@@ -63,6 +63,8 @@
 $string['customcert:viewallcertificates'] = 'View all certificates';
 $string['customcert:viewreport'] = 'View course report';
 $string['customcertsettings'] = 'Custom certificate settings';
+$string['customfilenamepattern'] = 'Custom file name pattern';
+$string['customfilenamepattern_help'] = 'Enter the pattern for naming certificate files. You can use placeholders such as {firstname}, {lastname}, {group}, {coursename}, {date}.';
 $string['deletecertpage'] = 'Delete page';
 $string['deleteconfirm'] = 'Delete confirmation';
 $string['deleteelement'] = 'Delete element';
@@ -201,6 +203,9 @@
 $string['refpoint_help'] = 'The reference point is the location of an element from which its x and y coordinates are determined. It is indicated by the \'+\' that appears in the centre or corners of the element.';
 $string['replacetemplate'] = 'Replace';
 $string['requiredtimenotmet'] = 'You must spend at least a minimum of {$a->requiredtime} minutes in the course before you can access this certificate.';
+$string['returncourse'] = 'Return to course button';
+$string['returncourse_desc'] = 'Display a "Return to course" button on the view certificate page.';
+$string['returncourselabel'] = 'Return to course page';
 $string['rightmargin'] = 'Right margin';
 $string['rightmargin_help'] = 'This is the right margin of the certificate PDF in mm.';
 $string['save'] = 'Save';
@@ -231,10 +236,12 @@
 $string['uploadimage'] = 'Upload image';
 $string['uploadimagedesc'] = 'This link will take you to a new screen where you will be able to upload images. Images uploaded using
 this method will be available throughout your site to all users who are able to create a certificate.';
-$string['useadhoc'] = 'Use Email Certificate Ad-hoc Task';
+$string['useadhoc'] = 'Use email certificate ad-hoc task';
 $string['useadhoc_desc'] = 'When enabled, emails related to certificates will be handled immediately through an ad-hoc task created for each issue. When disabled, emails will be managed by the regular scheduled task.
 
 Enabling this option may improve the performance of the scheduled task by offloading email processing to ad-hoc tasks.';
+$string['usecustomfilename'] = 'Use custom file name pattern';
+$string['usecustomfilename_help'] = 'If enabled, you can define a custom file name pattern for certificates using placeholders. The placeholders are {FIRST_NAME}, {LAST_NAME}, {GROUP_NAME}, {COURSE_SHORT_NAME}, {COURSE_FULL_NAME} and {ISSUE_DATE}.';
 $string['userlanguage'] = 'Use user preferences';
 $string['userlanguage_help'] = 'You can force the language of the certificate to override the user\'s language preferences.';
 $string['verified'] = 'Verified';
@@ -249,7 +256,3 @@
 $string['verifycertificatedesc'] = 'This link will take you to a new screen where you will be able to verify certificates on the site';
 $string['width'] = 'Width';
 $string['width_help'] = 'This is the width of the certificate PDF in mm. For reference an A4 piece of paper is 210mm wide and a letter is 216mm wide.';
-$string['codegenerationmethod'] = 'Code generation method';
-$string['codegenerationmethod_desc'] = 'Choose between the two methods for generating certificate codes.';
-$string['Upper/lower/digits'] = '6aOdbLEuoC (Upper/lower/digits random string)';
-$string['digits-with-hyphens'] = '0123-4567-8901 (Digits with hyphens)';
diff --git a/mod_form.php b/mod_form.php
@@ -66,6 +66,17 @@ public function definition() {
         $mform->addElement('select', 'deliveryoption', get_string('deliveryoptions', 'customcert'), $deliveryoptions);
         $mform->setDefault('deliveryoption', certificate::DELIVERY_OPTION_INLINE);
 
+        // Checkbox to enable custom file name pattern.
+        $mform->addElement('advcheckbox', 'usecustomfilename', get_string('usecustomfilename', 'customcert'));
+        $mform->addHelpButton('usecustomfilename', 'usecustomfilename', 'customcert');
+        $mform->setDefault('usecustomfilename', 0);
+
+        // Text field for custom file name pattern.
+        $mform->addElement('text', 'customfilenamepattern', get_string('customfilenamepattern', 'customcert'), ['size' => '50']);
+        $mform->setType('customfilenamepattern', PARAM_TEXT);
+        $mform->addHelpButton('customfilenamepattern', 'customfilenamepattern', 'customcert');
+        $mform->disabledIf('customfilenamepattern', 'usecustomfilename', 'notchecked');
+
         if (has_capability('mod/customcert:manageemailstudents', $this->get_context())) {
             $mform->addElement('selectyesno', 'emailstudents', get_string('emailstudents', 'customcert'));
             $mform->setDefault('emailstudents', get_config('customcert', 'emailstudents'));
diff --git a/settings.php b/settings.php
@@ -78,6 +78,11 @@
     get_string('certificateexecutionperiod', 'customcert'),
     get_string('certificateexecutionperiod_desc', 'customcert'), 365 * DAYSECS));
 
+$settings->add(new admin_setting_configcheckbox('customcert/returncourse',
+    get_string('returncourse', 'customcert'),
+    get_string('returncourse_desc', 'customcert'),
+    0));
+
 $settings->add(new admin_setting_heading('defaults',
     get_string('modeditdefaults', 'admin'), get_string('condifmodeditdefaults', 'admin')));
 
diff --git a/version.php b/version.php
@@ -24,7 +24,7 @@
 
 defined('MOODLE_INTERNAL') || die('Direct access to this script is forbidden.');
 
-$plugin->version   = 2024042212; // The current module version (Date: YYYYMMDDXX).
+$plugin->version   = 2024042213; // The current module version (Date: YYYYMMDDXX).
 $plugin->requires  = 2024042200; // Requires this Moodle version (4.4).
 $plugin->cron      = 0; // Period for cron to check this module (secs).
 $plugin->component = 'mod_customcert';
diff --git a/view.php b/view.php
@@ -157,12 +157,19 @@
 
     // Create the button to download the customcert.
     $downloadbutton = '';
+    $renderbuttoncourse = '';
+    $displayreturnbutton = get_config('customcert', 'returncourse');
     if ($canreceive) {
         $linkname = get_string('getcustomcert', 'customcert');
         $link = new moodle_url('/mod/customcert/view.php', ['id' => $cm->id, 'downloadown' => true]);
         $downloadbutton = new single_button($link, $linkname, 'get', single_button::BUTTON_PRIMARY);
         $downloadbutton->class .= ' m-b-1';  // Seems a bit hackish, ahem.
         $downloadbutton = $OUTPUT->render($downloadbutton);
+        if ($displayreturnbutton) {
+            $url = new moodle_url('/course/view.php', ['id' => $course->id]);
+            $buttonreturntocourse = new single_button($url, get_string('returncourselabel', 'customcert'), 'get');
+            $renderbuttoncourse = $OUTPUT->render($buttonreturntocourse);
+        }
     }
 
     $numissues = \mod_customcert\certificate::get_number_of_issues($customcert->id, $cm, $groupmode);
@@ -187,6 +194,9 @@
     echo $issuehtml;
     echo $downloadbutton;
     echo $downloadallbutton;
+    if ($displayreturnbutton) {
+        echo $renderbuttoncourse;
+    }
     if (isset($reporttable)) {
         echo $OUTPUT->heading(get_string('listofissues', 'customcert', $numissues), 3);
         groups_print_activity_menu($cm, $pageurl);
