mymodule.php

Go to the documentation of this file.

#!/usr/bin/env php
<?php
/* Copyright (C) 2007-2023  Laurent Destailleur     <eldy@users.sourceforge.net>
 * Copyright (C) 2024       Frédéric France         <frederic.france@free.fr>
 * Copyright (C) ---Replace with your own copyright and developer email---
 *
 * 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 <https://www.gnu.org/licenses/>.
 */
 
//if (! defined('NOREQUIREDB'))              define('NOREQUIREDB', '1');        // Do not create database handler $db
//if (! defined('NOREQUIREUSER'))            define('NOREQUIREUSER', '1');        // Do not load object $user
//if (! defined('NOREQUIRESOC'))             define('NOREQUIRESOC', '1');       // Do not load object $mysoc
//if (! defined('NOREQUIRETRAN'))            define('NOREQUIRETRAN', '1');        // Do not load object $langs
//if (! defined('NOSCANGETFORINJECTION'))    define('NOSCANGETFORINJECTION', '1');    // Do not check injection attack on GET parameters
//if (! defined('NOSCANPOSTFORINJECTION'))   define('NOSCANPOSTFORINJECTION', '1');   // Do not check injection attack on POST parameters
//if (! defined('NOTOKENRENEWAL'))           define('NOTOKENRENEWAL', '1');       // Do not roll the Anti CSRF token (used if MAIN_SECURITY_CSRF_WITH_TOKEN is on)
//if (! defined('NOSTYLECHECK'))             define('NOSTYLECHECK', '1');       // Do not check style html tag into posted data
//if (! defined('NOREQUIREMENU'))            define('NOREQUIREMENU', '1');        // If there is no need to load and show top and left menu
//if (! defined('NOREQUIREHTML'))            define('NOREQUIREHTML', '1');        // If we don't need to load the html.form.class.php
//if (! defined('NOREQUIREAJAX'))            define('NOREQUIREAJAX', '1');            // Do not load ajax.lib.php library
//if (! defined("NOLOGIN"))                  define("NOLOGIN", '1');          // If this page is public (can be called outside logged session). This include the NOIPCHECK too.
//if (! defined('NOIPCHECK'))                define('NOIPCHECK', '1');          // Do not check IP defined into conf $dolibarr_main_restrict_ip
//if (! defined("MAIN_LANG_DEFAULT"))        define('MAIN_LANG_DEFAULT', 'auto');         // Force lang to a particular value
//if (! defined("MAIN_AUTHENTICATION_MODE")) define('MAIN_AUTHENTICATION_MODE', 'aloginmodule');  // Force authentication handler
//if (! defined('CSRFCHECK_WITH_TOKEN'))     define('CSRFCHECK_WITH_TOKEN', '1');   // Force use of CSRF protection with tokens even for GET
//if (! defined('NOBROWSERNOTIF'))         define('NOBROWSERNOTIF', '1');       // Disable browser notification
if (!defined('NOSESSION')) {
  define('NOSESSION', '1');
} // On CLI mode, no need to use web sessions
 
 
$sapi_type = php_sapi_name();
$script_file = basename(__FILE__);
$path = __DIR__.'/';
 
// Test if batch mode
if (substr($sapi_type, 0, 3) == 'cgi') {  // @phan-suppress-current-line DolibarrForbiddenFunctionPlugin
  echo "Error: You are using PHP for CGI. To execute ".$script_file." from command line, you must use PHP for CLI mode.\n";
  exit(1);
}
 
// Global variables
$version = '1.0';
$error = 0;
 
 
// -------------------- START OF YOUR CODE HERE --------------------
@set_time_limit(0); // No timeout for this script
define('EVEN_IF_ONLY_LOGIN_ALLOWED', 1); // Set this define to 0 if you want to lock your script when dolibarr setup is "locked to admin user only".
 
// Load Dolibarr environment
$res = 0;
// Try master.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;  // @phan-suppress-current-line DolibarrForbiddenFunctionPlugin
$j = strlen($tmp2) - 1;  // @phan-suppress-current-line DolibarrForbiddenFunctionPlugin
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))."/master.inc.php")) {
  $res = @include substr($tmp, 0, ($i + 1))."/master.inc.php";  // @phan-suppress-current-line DolibarrForbiddenFunctionPlugin
}
if (!$res && $i > 0 && file_exists(dirname(substr($tmp, 0, ($i + 1)))."/master.inc.php")) {  // @phan-suppress-current-line DolibarrForbiddenFunctionPlugin
  $res = @include dirname(substr($tmp, 0, ($i + 1)))."/master.inc.php";  // @phan-suppress-current-line DolibarrForbiddenFunctionPlugin
}
// Try master.inc.php using relative path
if (!$res && file_exists("../master.inc.php")) {
  $res = @include "../master.inc.php";
}
if (!$res && file_exists("../../master.inc.php")) {
  $res = @include "../../master.inc.php";
}
if (!$res && file_exists("../../../master.inc.php")) {
  $res = @include "../../../master.inc.php";
}
if (!$res) {
  print "Include of master fails";
  exit(1);
}
// After this $db, $mysoc, $langs, $conf and $hookmanager are defined (Opened $db handler to database will be closed at end of file).
// $user is created but empty.
 
require_once DOL_DOCUMENT_ROOT . '/core/lib/functions.lib.php';
//$langs->setDefaultLang('en_US');  // To change default language of $langs
$langs->load("main"); // To load language file for default language
 
// Load user and its permissions
$result = $user->fetch(0, 'admin'); // Load user for login 'admin'. Comment line to run as anonymous user.
if (!($result > 0)) {
  dol_print_error(null, $user->error);
  exit;
}
$user->loadRights();
 
$hookmanager->initHooks(array('cli'));
 
 
/*
 * Main
 */
 
print "***** ".$script_file." (".$version.") pid=".dol_getmypid()." *****\n";
if (!isset($argv[1])) { // Check parameters
  print "Usage: ".$script_file." param1 param2 ...\n";
  exit(1);
}
print '--- start'."\n";
print 'Argument 1='.$argv[1]."\n";
print 'Argument 2='.$argv[2]."\n";
 
 
// Start of transaction
$db->begin();
 
 
// Examples for manipulating class MyObject
//dol_include_once("/mymodule/class/myobject.class.php");
//$myobject=new MyObject($db);
 
// Example for inserting creating object in database
/*
dol_syslog($script_file." CREATE", LOG_DEBUG);
$myobject->prop1='value_prop1';
$myobject->prop2='value_prop2';
$id=$myobject->create($user);
if ($id < 0) { $error++; dol_print_error($db,$myobject->error); }
else print "Object created with id=".$id."\n";
*/
 
// Example for reading object from database
/*
dol_syslog($script_file." FETCH", LOG_DEBUG);
$result=$myobject->fetch($id);
if ($result < 0) { $error; dol_print_error($db,$myobject->error); }
else print "Object with id=".$id." loaded\n";
*/
 
// Example for updating object in database ($myobject must have been loaded by a fetch before)
/*
dol_syslog($script_file." UPDATE", LOG_DEBUG);
$myobject->prop1='newvalue_prop1';
$myobject->prop2='newvalue_prop2';
$result=$myobject->update($user);
if ($result < 0) { $error++; dol_print_error($db,$myobject->error); }
else print "Object with id ".$myobject->id." updated\n";
*/
 
// Example for deleting object in database ($myobject must have been loaded by a fetch before)
/*
dol_syslog($script_file." DELETE", LOG_DEBUG);
$result=$myobject->delete($user);
if ($result < 0) { $error++; dol_print_error($db,$myobject->error); }
else print "Object with id ".$myobject->id." deleted\n";
*/
 
 
// An example of a direct SQL read without using the fetch method
/*
$sql = "SELECT field1, field2";
$sql.= " FROM ".$db->prefix()."myobject";
$sql.= " WHERE field3 = 'xxx'";
$sql.= " ORDER BY field1 ASC";
 
dol_syslog($script_file, LOG_DEBUG);
$resql=$db->query($sql);
if ($resql)
{
  $num = $db->num_rows($resql);
  $i = 0;
  if ($num)
  {
    while ($i < $num)
    {
      $obj = $db->fetch_object($resql);
      if ($obj)
      {
        // You can use here results
        print $obj->field1;
        print $obj->field2;
      }
      $i++;
    }
  }
}
else
{
  $error++;
  dol_print_error($db);
}
*/
 
 
// -------------------- END OF YOUR CODE --------------------
 
if (!$error) {
  $db->commit();
  print '--- end ok'."\n";
} else {
  print '--- end error code='.$error."\n";
  $db->rollback();
}
 
$db->close(); // Close $db database opened handler
 
exit($error);