Dolibarr\Code\Core\Classes\Utils::generateDoc()

Complexity

Conditions	28
Paths	2679

Size

Total Lines	193
Code Lines	129

Duplication

Lines	0
Ratio	0 %

Importance

Changes

0

<?php
    public function generateDoc($module)
    {
        global $conf, $langs, $user, $mysoc;
        global $dirins;

        $error = 0;

        $modulelowercase = strtolower($module);
        $now = dol_now();

        // Dir for module
        $dir = $dirins . '/' . $modulelowercase;
        // Zip file to build
        $FILENAMEDOC = '';

        // Load module
        dol_include_once($modulelowercase . '/core/modules/mod' . $module . '.class.php');
        $class = 'mod' . $module;

        if (class_exists($class)) {
            try {
                $moduleobj = new $class($this->db);
            } catch (Exception $e) {

The type Dolibarr\Code\Core\Classes\Exception was not found. Did you mean Exception? If so, make sure to prefix the type with \.

                $error++;
                dol_print_error(null, $e->getMessage());
            }
        } else {
            $error++;
            $langs->load("errors");
            dol_print_error(null, $langs->trans("ErrorFailedToLoadModuleDescriptorForXXX", $module));
            exit;

Using exit here is not recommended.

        }

        $arrayversion = explode('.', $moduleobj->version, 3);
        if (count($arrayversion)) {
            $FILENAMEASCII = strtolower($module) . '.asciidoc';
            $FILENAMEDOC = strtolower($module) . '.html';
            $FILENAMEDOCPDF = strtolower($module) . '.pdf';

            $dirofmodule = dol_buildpath(strtolower($module), 0);
            $dirofmoduledoc = dol_buildpath(strtolower($module), 0) . '/doc';
            $dirofmoduletmp = dol_buildpath(strtolower($module), 0) . '/doc/temp';
            $outputfiledoc = $dirofmoduledoc . '/' . $FILENAMEDOC;
            if ($dirofmoduledoc) {
                if (!dol_is_dir($dirofmoduledoc)) {
                    dol_mkdir($dirofmoduledoc);
                }
                if (!dol_is_dir($dirofmoduletmp)) {
                    dol_mkdir($dirofmoduletmp);
                }
                if (!is_writable($dirofmoduletmp)) {
                    $this->error = 'Dir ' . $dirofmoduletmp . ' does not exists or is not writable';
                    return -1;
                }

                if (!getDolGlobalString('MODULEBUILDER_ASCIIDOCTOR') && !getDolGlobalString('MODULEBUILDER_ASCIIDOCTORPDF')) {
                    $this->error = 'Setup of module ModuleBuilder not complete';
                    return -1;
                }

                // Copy some files into temp directory, so instruction include::ChangeLog.md[] will works inside the asciidoc file.
                dol_copy($dirofmodule . '/README.md', $dirofmoduletmp . '/README.md', 0, 1);
                dol_copy($dirofmodule . '/ChangeLog.md', $dirofmoduletmp . '/ChangeLog.md', 0, 1);

                // Replace into README.md and ChangeLog.md (in case they are included into documentation with tag __README__ or __CHANGELOG__)
                $arrayreplacement = array();
                $arrayreplacement['/^#\s.*/m'] = ''; // Remove first level of title into .md files
                $arrayreplacement['/^#/m'] = '##'; // Add on # to increase level

                dolReplaceInFile($dirofmoduletmp . '/README.md', $arrayreplacement, '', 0, 0, 1);
                dolReplaceInFile($dirofmoduletmp . '/ChangeLog.md', $arrayreplacement, '', 0, 0, 1);


                $destfile = $dirofmoduletmp . '/' . $FILENAMEASCII;

                $fhandle = fopen($destfile, 'w+');
                if ($fhandle) {
                    $specs = dol_dir_list(dol_buildpath(strtolower($module) . '/doc', 0), 'files', 1, '(\.md|\.asciidoc)$', array('\/temp\/'));

                    $i = 0;
                    foreach ($specs as $spec) {
                        if (preg_match('/notindoc/', $spec['relativename'])) {
                            continue; // Discard file
                        }
                        if (preg_match('/example/', $spec['relativename'])) {
                            continue; // Discard file
                        }
                        if (preg_match('/disabled/', $spec['relativename'])) {
                            continue; // Discard file
                        }

                        $pathtofile = strtolower($module) . '/doc/' . $spec['relativename'];
                        $format = 'asciidoc';
                        if (preg_match('/\.md$/i', $spec['name'])) {
                            $format = 'markdown';
                        }

                        $filecursor = @file_get_contents($spec['fullname']);
                        if ($filecursor) {
                            fwrite($fhandle, ($i ? "\n<<<\n\n" : "") . $filecursor . "\n");
                        } else {
                            $this->error = 'Failed to concat content of file ' . $spec['fullname'];
                            return -1;
                        }

                        $i++;
                    }

                    fclose($fhandle);

                    $contentreadme = file_get_contents($dirofmoduletmp . '/README.md');
                    $contentchangelog = file_get_contents($dirofmoduletmp . '/ChangeLog.md');

                    include DOL_DOCUMENT_ROOT . '/core/lib/parsemd.lib.php';

                    //var_dump($phpfileval['fullname']);
                    $arrayreplacement = array(
                        'mymodule' => strtolower($module),
                        'MyModule' => $module,
                        'MYMODULE' => strtoupper($module),
                        'My module' => $module,
                        'my module' => $module,
                        'Mon module' => $module,
                        'mon module' => $module,
                        'htdocs/modulebuilder/template' => strtolower($module),
                        '__MYCOMPANY_NAME__' => $mysoc->name,
                        '__KEYWORDS__' => $module,
                        '__USER_FULLNAME__' => $user->getFullName($langs),
                        '__USER_EMAIL__' => $user->email,
                        '__YYYY-MM-DD__' => dol_print_date($now, 'dayrfc'),
                        '---Put here your own copyright and developer email---' => dol_print_date($now, 'dayrfc') . ' ' . $user->getFullName($langs) . ($user->email ? ' <' . $user->email . '>' : ''),
                        '__DATA_SPECIFICATION__' => 'Not yet available',
                        '__README__' => dolMd2Asciidoc($contentreadme),
                        '__CHANGELOG__' => dolMd2Asciidoc($contentchangelog),
                    );

                    // @phan-suppress-next-line PhanPluginSuspiciousParamPosition
                    dolReplaceInFile($destfile, $arrayreplacement);
                }

                // Launch doc generation
                $currentdir = getcwd();
                chdir($dirofmodule);

                require_once constant('DOL_DOCUMENT_ROOT') . '/core/class/utils.class.php';
                $utils = new Utils($this->db);

                // Build HTML doc
                $command = getDolGlobalString('MODULEBUILDER_ASCIIDOCTOR') . ' ' . $destfile . ' -n -o ' . $dirofmoduledoc . '/' . $FILENAMEDOC;
                $outfile = $dirofmoduletmp . '/out.tmp';

                $resarray = $utils->executeCLI($command, $outfile);
                if ($resarray['result'] != '0') {
                    $this->error = $resarray['error'] . ' ' . $resarray['output'];
                    $this->errors[] = $this->error;
                }
                $result = ($resarray['result'] == 0) ? 1 : 0;
                if ($result < 0 && empty($this->errors)) {
                    $this->error = $langs->trans("ErrorFailToGenerateFile", $FILENAMEDOC);
                    $this->errors[] = $this->error;
                }

                // Build PDF doc
                $command = getDolGlobalString('MODULEBUILDER_ASCIIDOCTORPDF') . ' ' . $destfile . ' -n -o ' . $dirofmoduledoc . '/' . $FILENAMEDOCPDF;
                $outfile = $dirofmoduletmp . '/outpdf.tmp';
                $resarray = $utils->executeCLI($command, $outfile);
                if ($resarray['result'] != '0') {
                    $this->error = $resarray['error'] . ' ' . $resarray['output'];
                    $this->errors[] = $this->error;
                }
                $result = ($resarray['result'] == 0) ? 1 : 0;
                if ($result < 0 && empty($this->errors)) {
                    $this->error = $langs->trans("ErrorFailToGenerateFile", $FILENAMEDOCPDF);
                    $this->errors[] = $this->error;
                }

                chdir($currentdir);
            } else {
                $result = 0;
            }

            if ($result > 0) {
                return 1;
            } else {
                $error++;
            }
        } else {
            $error++;
            $langs->load("errors");
            $this->error = $langs->trans("ErrorCheckVersionIsDefined");
        }

        return -1;
    }