Merge branch 'develop' of git@github.com:Dolibarr/dolibarr.git into develop

This commit is contained in:
Laurent Destailleur 2024-01-21 19:53:19 +01:00
commit db21befda1
17 changed files with 255 additions and 146 deletions

View file

@ -44,7 +44,8 @@ jobs:
# Restore old cache
- name: Restore phpstan cache
uses: actions/cache/restore@v3
id: cache
uses: actions/cache/restore@v4
with:
path: ./.github/tmp
key: "phpstan-cache-${{ matrix.php-version }}-${{ github.run_id }}"
@ -55,13 +56,14 @@ jobs:
# Run PHPStan
- name: Run PHPStan
id: phpstan
run: phpstan -vvv analyse --error-format=checkstyle --memory-limit 4G -a build/phpstan/bootstrap_action.php -c phpstan.neon | cs2pr --graceful-warnings
# continue-on-error: true
# Save cache
- name: "Save phpstan cache"
uses: actions/cache/save@v3
if: always()
uses: actions/cache/save@v4
if: ${{ success() || ( ! cancelled() && steps.cache.outputs.cache-hit != 'true' ) }}
with:
path: ./.github/tmp
key: "phpstan-cache-${{ matrix.php-version }}-${{ github.run_id }}"

View file

@ -27,7 +27,7 @@ jobs:
python-version: '3.11'
- run: python -m pip install pre-commit regex
# Restore previous cache of precommit
- uses: actions/cache/restore@v3
- uses: actions/cache/restore@v4
with:
path: ~/.cache/pre-commit/
key: pre-commit-4|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml') }}
@ -54,8 +54,8 @@ jobs:
notices-as-warnings: true # optional
prepend-filename: true # optional
# Save the precommit cache
- uses: actions/cache/save@v3
if: ${{ always() }}
- uses: actions/cache/save@v4
if: ${{ ! cancelled() }}
with:
path: ~/.cache/pre-commit/
key: pre-commit-4|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml')
@ -63,7 +63,7 @@ jobs:
# Upload result log files of precommit into the Artifact shared store
- name: Provide log as artifact
uses: actions/upload-artifact@v4
if: ${{ always() }}
if: ${{ ! cancelled() }}
with:
name: precommit-logs
path: |

View file

@ -34,6 +34,15 @@ repos:
args: [--tab]
# Run local script
#
# For instance to update the license in edited files, you could add to local.sh:
#
# ```shell
# #!/bin/bash
# MYDIR=$(dirname "$0")
# CHANGED_INTERNALS=$(git diff --name-only | grep -v includes)
# "$MYDIR/dev/tools/updatelicense.php" $CHANGED_INTERNALS
# ```
- repo: local
hooks:
- id: local-precommit-script

View file

@ -1,7 +1,7 @@
README (English)
--------------------------------
This directory contains ruleset files to use to develop Dolibarr EPR & CRM.
This directory contains ruleset files to use to develop Dolibarr ERP & CRM.
To install/upgrade phpcs:
> sudo pear upgrade PHP_CodeSniffer
@ -17,5 +17,4 @@ To fix with phpcbf:
Note with Eclipse: You must setup the PTI plugin of Eclipse into PHPCodeSniffer menu with:
* tab value to 4
* path of code sniffer standard to dev/codesniffer
* path of code sniffer standard to dev/codesniffer

View file

@ -1,4 +1,6 @@
#!/bin/bash
# Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
#
# Script to add codespell exceptions to the ignores lines file.
#
@ -18,7 +20,7 @@
#
# :warning:
#
# This script only works properly if codespell is install for your CLI.
# This script only works properly if codespell is installed for your CLI.
# As the configuration is in pyproject.toml, you also need tomli.
#
# ```shell
@ -50,11 +52,17 @@ fi
[ -r "${codespell_ignore_file}" ] || { echo "${codespell_ignore_file} not found" ; exit 1 ; }
# Then:
# - Run codespell;
# - Identify files that have fixes;
# - Limit to files under git control;
# - Run codespell on selected files;
# - For each line, create a grep command to find the lines;
# - Execute that command by evaluation
codespell . | sed -n -E 's@^([^:]+):[[:digit:]]+:[[:space:]](\S+)[[:space:]].*@grep -P '\''\\b\2\\b'\'' "\1" >> '"${codespell_ignore_file}"'@p' | \
while read -r line ; do eval "$line" ; done
codespell . \
| sed -n -E 's@^([^:]+)@\1@p' \
| xargs -r git ls-files -- \
| xargs -r codespell -- \
| sed -n -E 's@^([^:]+):[[:digit:]]+:[[:space:]](\S+)[[:space:]].*@grep -P '\''\\b\2\\b'\'' -- "\1" >> '"${codespell_ignore_file}"'@p' \
| while read -r line ; do eval "$line" ; done
# Finally, sort and remove duplicates to make merges easier.
sort -u -o "${codespell_ignore_file}"{,}

View file

@ -1,9 +1,10 @@
# Please add in alphabetical order->(`sort -u` like).
EPR->ERP
alpahnohtml->alphanohtml
choosed->chosen
dolibar->dolibarr
dollibar->dolibarr
dollibarr->dolibarr
not de passe->password
mot de passe->password
choosed->chosen
not de passe->password
tableau de bord->state board
#DoliDB->DoliDB
alpahnohtml->alphanohtml

154
dev/tools/updatelicense.php Executable file
View file

@ -0,0 +1,154 @@
#!/usr/bin/env php
<?php
/* Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is furnished
* to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
/**
* Script to update year periods and user/email in headers.
*/
/**
* Retrieve Git user information
*
* @return array{name:string,email:string}
*/
function getGitUserInfo()
{
$name = trim(shell_exec('git config user.name'));
$email = trim(shell_exec('git config user.email'));
return ['name' => $name, 'email' => $email];
}
const PREFIXES = [
'sh' => ['# ', '# ', '', '#!'],
'php' => ['/* ', ' * ', ' */', '<?php'],
];
/**
* Update or add copyright notice in a file
*
* @param $filename string Path to the file to modify
* @param $fileType string Filetype identification for the file
* @param $name string Name of developer to add in header
* @param $email string Email for the developer
*
* @return bool True if license was updated
*/
function updateCopyrightNotice($filename, $fileType, $name, $email)
{
// Determine the appropriate prefix based on file type
if (!array_key_exists($fileType, PREFIXES)) {
return false;
}
// Get configuration for the filetype
list($prefix0, $prefix1, $prefix2, $prefix3) = PREFIXES[$fileType];
$r_prefix0 = preg_quote($prefix0);
$r_prefix1 = preg_quote($prefix1);
$r_prefix3 = preg_quote($prefix3);
$r_name = preg_quote($name);
$r_email = preg_quote($email);
// Read the first n lines of the file
$n = 50;
$lines = implode('', array_slice(file($filename), 0, $n));
// Define the regex pattern for matching copyright notices
$pattern = "~(?:{$r_prefix0}|{$r_prefix1})Copyright \(C\)\s+(?:(?:\d{4}-)?(?<year>\d{4}))\s+{$r_name}\s*\<{$r_email}>~";
// Check if the lines match the pattern
if (preg_match($pattern, $lines, $matches)) {
$existingYear = $matches['year'];
// Check if the existing year is different from the current year
if ($existingYear !== date('Y')) {
// Update the year range to include or be up to the current year
$updatedNotice = preg_replace('/(\d{4})(-\d{4})?\s+/', $existingYear . '-' . date('Y') . "\t", $matches[0]);
// Replace the old notice with the updated one in the file
file_put_contents($filename, preg_replace($pattern, $updatedNotice, file_get_contents($filename)));
return true; // Change detected
}
// If the existing year is the same, no need to update
} else {
// Adjust tabs for proper alignment
$emailTabs = str_repeat("\t", (int) (max(0, (31 - mb_strlen($name)) / 4)));
// No match found, add a new line to the header
$newNotice = "Copyright (C) " . date('Y') . "\t\t" . $name . $emailTabs . "<" . $email . ">";
// Read the file content
$fileContent = file_get_contents($filename);
// Check if there are existing copyright notices
$pos = max(strrpos($fileContent, "{$prefix0}Copyright"), strrpos($fileContent, "{$prefix1}Copyright"));
if ($pos !== false) {
// Add the new notice behind the last preceding copyright notices
$pos = strpos($fileContent, "\n", $pos) + 1;
$fileContent = substr_replace($fileContent, $prefix1 . $newNotice . "\n", $pos, 0);
} elseif (strpos($fileContent, $prefix3) !== false) {
// Add the new notice after the shebang or '<?php' line
$fileContent = preg_replace("~{$r_prefix3}.*\n~", "$0$prefix0$newNotice\n$prefix2\n", $fileContent, 1);
} else {
return false; // No change detected
}
// Write the updated content back to the file
file_put_contents($filename, $fileContent);
return true; // Change detected
}
return false; // No change detected
}
// Main program
// Check if filenames are provided as parameters
if ($argc < 2) {
echo "Usage: php " . __FILE__ . " <filename1> [<filename2> ...]" . PHP_EOL;
exit(1);
}
// Process each filename provided
$changesDetected = false;
for ($i = 1; $i < $argc; $i++) {
$filename = $argv[$i];
// Determine file type based on extension
$fileType = pathinfo($filename, PATHINFO_EXTENSION);
// Retrieve Git user information
$gitUserInfo = getGitUserInfo();
$name = $gitUserInfo['name'];
$email = $gitUserInfo['email'];
// Update or add copyright notice based on file type
$changeDetected = updateCopyrightNotice($filename, $fileType, $name, $email);
$changesDetected |= $changeDetected;
if ($changeDetected) {
echo "Copyright notice updated in '$filename'" . PHP_EOL;
}
}
if (!$changesDetected) {
echo "No changes needed in any file" . PHP_EOL;
}

View file

@ -1372,6 +1372,7 @@ function dol_sanitizeFileName($str, $newstr = '_', $unaccent = 1)
return $tmp;
}
/**
* Clean a string to use it as a path name. Similare to dol_sanitizeFileName but accept / and \ chars.
* Replace also '--' and ' -' strings, they are used for parameters separation (Note: ' - ' is allowed).
@ -2795,15 +2796,15 @@ function dol_format_address($object, $withcountry = 0, $sep = "\n", $outputlangs
*
* @param string $fmt Format of strftime function (http://php.net/manual/fr/function.strftime.php)
* @param int $ts Timestamp (If is_gmt is true, timestamp is already includes timezone and daylight saving offset, if is_gmt is false, timestamp is a GMT timestamp and we must compensate with server PHP TZ)
* @param int $is_gmt See comment of timestamp parameter
* @param bool $is_gmt See comment of timestamp parameter
* @return string A formatted string
*/
function dol_strftime($fmt, $ts = false, $is_gmt = false)
{
if ((abs($ts) <= 0x7FFFFFFF)) { // check if number in 32-bit signed range
return ($is_gmt) ? @gmstrftime($fmt, $ts) : @dol_print_date($ts, $fmt);
return dol_print_date($ts, $fmt, $is_gmt);
} else {
return 'Error date into a not supported range';
return 'Error date outside supported range';
}
}
@ -2818,7 +2819,7 @@ function dol_strftime($fmt, $ts = false, $is_gmt = false)
* "%d/%m/%Y %H:%M:%S",
* "%B"=Long text of month, "%A"=Long text of day, "%b"=Short text of month, "%a"=Short text of day
* "day", "daytext", "dayhour", "dayhourldap", "dayhourtext", "dayrfc", "dayhourrfc", "...inputnoreduce", "...reduceformat"
* @param string $tzoutput true or 'gmt' => string is for Greenwich location
* @param string|bool $tzoutput true or 'gmt' => string is for Greenwich location
* false or 'tzserver' => output string is for local PHP server TZ usage
* 'tzuser' => output string is for user TZ (current browser TZ with current dst) => In a future, we should have same behaviour than 'tzuserrel'
* 'tzuserrel' => output string is for user TZ (current browser TZ with dst or not, depending on date position)

View file

@ -559,6 +559,7 @@ class Cronjob extends CommonObject
$sql .= " t.fk_user_mod,";
$sql .= " t.note as note_private,";
$sql .= " t.nbrun,";
$sql .= " t.maxrun,";
$sql .= " t.libname,";
$sql .= " t.test";
$sql .= " FROM ".MAIN_DB_PREFIX."cronjob as t";
@ -595,45 +596,46 @@ class Cronjob extends CommonObject
if ($num) {
while ($i < $num) {
$line = new Cronjobline();
$obj = $this->db->fetch_object($resql);
$cronjob_obj = new Cronjob($this->db);
$line->id = $obj->rowid;
$line->ref = $obj->rowid;
$line->entity = $obj->entity;
$line->tms = $this->db->jdate($obj->tms);
$line->datec = $this->db->jdate($obj->datec);
$line->label = $obj->label;
$line->jobtype = $obj->jobtype;
$line->command = $obj->command;
$line->classesname = $obj->classesname;
$line->objectname = $obj->objectname;
$line->methodename = $obj->methodename;
$line->params = $obj->params;
$line->md5params = $obj->md5params;
$line->module_name = $obj->module_name;
$line->priority = $obj->priority;
$line->datelastrun = $this->db->jdate($obj->datelastrun);
$line->datenextrun = $this->db->jdate($obj->datenextrun);
$line->dateend = $this->db->jdate($obj->dateend);
$line->datestart = $this->db->jdate($obj->datestart);
$line->lastresult = $obj->lastresult;
$line->datelastresult = $this->db->jdate($obj->datelastresult);
$line->lastoutput = $obj->lastoutput;
$line->unitfrequency = $obj->unitfrequency;
$line->frequency = $obj->frequency;
$line->status = $obj->status;
$line->processing = $obj->processing;
$line->pid = $obj->pid;
$line->email_alert = $obj->email_alert;
$line->fk_user_author = $obj->fk_user_author;
$line->fk_user_mod = $obj->fk_user_mod;
$line->note_private = $obj->note_private;
$line->nbrun = $obj->nbrun;
$line->libname = $obj->libname;
$line->test = $obj->test;
$this->lines[] = $line;
$cronjob_obj->id = $obj->rowid;
$cronjob_obj->ref = $obj->rowid;
$cronjob_obj->entity = $obj->entity;
$cronjob_obj->tms = $this->db->jdate($obj->tms);
$cronjob_obj->datec = $this->db->jdate($obj->datec);
$cronjob_obj->label = $obj->label;
$cronjob_obj->jobtype = $obj->jobtype;
$cronjob_obj->command = $obj->command;
$cronjob_obj->classesname = $obj->classesname;
$cronjob_obj->objectname = $obj->objectname;
$cronjob_obj->methodename = $obj->methodename;
$cronjob_obj->params = $obj->params;
$cronjob_obj->md5params = $obj->md5params;
$cronjob_obj->module_name = $obj->module_name;
$cronjob_obj->priority = $obj->priority;
$cronjob_obj->datelastrun = $this->db->jdate($obj->datelastrun);
$cronjob_obj->datenextrun = $this->db->jdate($obj->datenextrun);
$cronjob_obj->dateend = $this->db->jdate($obj->dateend);
$cronjob_obj->datestart = $this->db->jdate($obj->datestart);
$cronjob_obj->lastresult = $obj->lastresult;
$cronjob_obj->lastoutput = $obj->lastoutput;
$cronjob_obj->datelastresult = $this->db->jdate($obj->datelastresult);
$cronjob_obj->unitfrequency = $obj->unitfrequency;
$cronjob_obj->frequency = $obj->frequency;
$cronjob_obj->status = $obj->status;
$cronjob_obj->processing = $obj->processing;
$cronjob_obj->pid = $obj->pid;
$cronjob_obj->email_alert = $obj->email_alert;
$cronjob_obj->fk_user_author = $obj->fk_user_author;
$cronjob_obj->fk_user_mod = $obj->fk_user_mod;
$cronjob_obj->note_private = $obj->note_private;
$cronjob_obj->nbrun = $obj->nbrun;
$cronjob_obj->maxrun = $obj->maxrun;
$cronjob_obj->libname = $obj->libname;
$cronjob_obj->test = $obj->test;
$this->lines[] = $cronjob_obj;
$i++;
}
@ -1572,76 +1574,9 @@ class Cronjob extends CommonObject
/**
* Crob Job line class
* Crob Job line class
* @TODO Deprecated, to delete very soon
*/
class Cronjobline
class Cronjobline extends Cronjob
{
/**
* @var int ID
*/
public $id;
public $entity;
/**
* @var string Ref
*/
public $ref;
public $tms = '';
public $datec = '';
/**
* @var string Cron Job Line label
*/
public $label;
public $jobtype;
public $command;
public $classesname;
public $objectname;
public $methodename;
public $params;
public $md5params;
public $module_name;
public $priority;
public $datelastrun = '';
public $datenextrun = '';
public $dateend = '';
public $datestart = '';
public $datelastresult = '';
public $lastresult = '';
public $lastoutput;
public $unitfrequency;
public $frequency;
public $processing;
/**
* @var int Status
*/
public $status;
/**
* @var int ID
*/
public $fk_user_author;
/**
* @var int ID
*/
public $fk_user_mod;
public $note;
public $note_private;
public $nbrun;
public $libname;
public $test;
/**
* Constructor
*
*/
public function __construct()
{
}
}

View file

@ -62,7 +62,7 @@ $page = GETPOSTISSET('pageplusone') ? (GETPOST('pageplusone') - 1) : GETPOST("pa
// Security check
$id = (GETPOST('facid', 'int') ? GETPOST('facid', 'int') : GETPOST('id', 'int'));
$lineid = GETPOST('lineid', 'int');
$lineid = GETPOSTINT('lineid');
$title = GETPOST('title', 'alpha');
$libelle = GETPOST('libelle', 'alpha');
$ref_supplier = GETPOST('ref_supplier', 'alpha');
@ -194,7 +194,7 @@ if (empty($reshook)) {
$object->title = GETPOST('title', 'alphanohtml');
$object->libelle = GETPOST('libelle', 'alpha'); // deprecated
$object->label = GETPOST('libelle', 'alpha');
$object->fk_project = GETPOST('projectid', 'int');
$object->fk_project = GETPOSTINT('projectid');
$object->ref_supplier = GETPOST('ref_supplier', 'alphanohtml');
$object->note_private = GETPOST('note_private', 'restricthtml');

View file

@ -760,7 +760,7 @@ if (empty($reshook)) {
} elseif ($action == 'add' && $usercancreate) {
// Insert new invoice in database
if ($socid > 0) {
$object->socid = GETPOST('socid', 'int');
$object->socid = GETPOSTINT('socid');
}
$selectedLines = GETPOST('toselect', 'array');

View file

@ -183,7 +183,7 @@ if (empty($reshook)) {
$halfday = 1;
}
$approverid = GETPOST('valideur', 'int');
$approverid = GETPOSTINT('valideur');
$description = trim(GETPOST('description', 'restricthtml'));
// Check that leave is for a user inside the hierarchy or advanced permission for all is set

View file

@ -185,4 +185,4 @@ EvenUnsubscribe=Include opt-out emails
EvenUnsubscribeDesc=Include opt-out emails when you select emails as targets. Useful for mandatory service emails for example.
XEmailsDoneYActionsDone=%s emails pre-qualified, %s emails successfully processed (for %s record/actions done)
helpWithAi=Add instructions
YouCanMakeSomeInstructionForEmail=You Can Make Some Instruction For your Email (Exemple: generate image in email template...)
YouCanMakeSomeInstructionForEmail=You can add some instructions for your email (Example: generate image in email template...)

View file

@ -132,7 +132,7 @@ if (empty($reshook)) {
if (!$error) {
$object->label = GETPOST('label');
$object->fk_bank = GETPOST('accountid');
$object->fk_bank = GETPOSTINT('accountid');
$object->capital = $capital;
$object->datestart = $datestart;
$object->dateend = $dateend;
@ -140,7 +140,7 @@ if (empty($reshook)) {
$object->rate = $rate;
$object->note_private = GETPOST('note_private', 'restricthtml');
$object->note_public = GETPOST('note_public', 'restricthtml');
$object->fk_project = GETPOST('projectid', 'int');
$object->fk_project = GETPOSTINT('projectid');
$object->insurance_amount = GETPOST('insurance_amount', 'int');
$accountancy_account_capital = GETPOST('accountancy_account_capital');

View file

@ -736,7 +736,7 @@ class Mos extends DolibarrApi
*
* @return void
*/
private function checkRefNumbering(): void
private function checkRefNumbering()
{
$ref = substr($this->mo->ref, 1, 4);
if ($this->mo->status > 0 && $ref == 'PROV') {

View file

@ -575,7 +575,7 @@ if (empty($reshook)) {
// Set barcode_type_xxx from barcode_type id
$stdobject = new GenericObject($db);
$stdobject->element = 'product';
$stdobject->barcode_type = GETPOST('fk_barcode_type');
$stdobject->barcode_type = GETPOSTINT('fk_barcode_type');
$result = $stdobject->fetch_barcode();
if ($result < 0) {
$error++;
@ -817,7 +817,7 @@ if (empty($reshook)) {
// Set barcode_type_xxx from barcode_type id
$stdobject = new GenericObject($db);
$stdobject->element = 'product';
$stdobject->barcode_type = GETPOST('fk_barcode_type');
$stdobject->barcode_type = GETPOSTINT('fk_barcode_type');
$result = $stdobject->fetch_barcode();
if ($result < 0) {
$error++;

View file

@ -663,10 +663,10 @@ class Product extends CommonObject
$this->ref = dol_sanitizeFileName(dol_string_nospecial(trim($this->ref)));
}
$this->label = trim($this->label);
$this->price_ttc = price2num($this->price_ttc);
$this->price = price2num($this->price);
$this->price_min_ttc = price2num($this->price_min_ttc);
$this->price_min = price2num($this->price_min);
$this->price_ttc = (float) price2num($this->price_ttc);
$this->price = (float) price2num($this->price);
$this->price_min_ttc = (float) price2num($this->price_min_ttc);
$this->price_min = (float) price2num($this->price_min);
if (empty($this->tva_tx)) {
$this->tva_tx = 0;
}
@ -4542,7 +4542,7 @@ class Product extends CommonObject
*
* @param int $fk_parent Id of parent kit product
* @param int $fk_child Id of child product
* @return int Return integer <0 if KO, >0 if OK
* @return int Return 1 or 0; -1 if error
*/
public function is_sousproduit($fk_parent, $fk_child)
{
@ -4562,9 +4562,9 @@ class Product extends CommonObject
$this->is_sousproduit_qty = $obj->qty;
$this->is_sousproduit_incdec = $obj->incdec;
return true;
return 1;
} else {
return false;
return 0;
}
} else {
dol_print_error($this->db);