includes/hooks.inc

   1 <?php
   2 /**********************************************************************
   3     Copyright (C) FrontAccounting, LLC.
   4         Released under the terms of the GNU General Public License, GPL,
   5         as published by the Free Software Foundation, either version 3
   6         of the License, or (at your option) any later version.
   7     This program is distributed in the hope that it will be useful,
   8     but WITHOUT ANY WARRANTY; without even the implied warranty of
   9     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  10     See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
  11 ***********************************************************************/
  12 //
  13 // FrontAccounting extension modules integration.
  14 // This file is included in session.inc even before session is started,
  15 // and includes hooks.php connector files from all installed extensions.
  16 // To make hooks active install_hooks() have to be called after interface
  17 // language is set.
  18 //
  19 // To find how various hooks are processed look into respective hook_* functions below.
  20 //
  21 class hooks {
  22         var $module_name; // extension module name.
  23
  24         //
  25         // Helper for updating databases with extension scheme
  26         //
  27         // $comp can be company number, -1 for all,
  28         // $updates - table of filename => array(table, field, property)
  29         // $check_only - don't update database, check table/field/property existence only
  30         //
  31         function update_databases($comp, $updates, $check_only=false)
  32         {
  33                 global $db_connections, $path_to_root;
  34
  35                 if ($comp == -1)
  36                         $conn = $db_connections;
  37                 else
  38                         $conn = array( $comp => $db_connections[$comp]);
  39                 $result = true;
  40
  41                 foreach($conn as $comp => $con) {
  42                         set_global_connection($comp);
  43                         foreach($updates as $file => $update) {
  44                                 $table = @$update[0];
  45                                 $field = @$update[1];
  46                                 $properties = @$update[2];
  47
  48                                 $ok = check_table($con['tbpref'], $table, $field, $properties) == 0;
  49
  50                                 if (!$check_only && !$ok) {
  51                                         $ok = db_import($path_to_root.'/modules/'.$this->module_name.'/sql/'.$file,
  52                                                 $con);
  53                                 }
  54                                 $result &= $ok;
  55                                 if (!$result)
  56                                         break;
  57                         }
  58                         db_close();
  59                         if (!$result)
  60                                 break;
  61                 }
  62                 set_global_connection(0); // return to siteadmin account
  63
  64                 return $result;
  65         }
  66         //
  67         //      Install additional tabs provided by extension
  68         //
  69         function install_tabs($app)
  70         {
  71 //              $app->add_application(new example_class); // add menu tab defined by example_class
  72         }
  73         //
  74         //      Install additonal menu options provided by extension
  75         //
  76         function install_options($app)
  77         {
  78 //              global $path_to_root;
  79 //
  80 //              switch($app->id) {
  81 //                      case 'orders':
  82 //                              $app->add_rapp_function( 0, _("&Example option"),
  83 //                                      $path_to_root.'/modules/example/example.php?', 'SA_OPEN');
  84 //              }
  85         }
  86
  87         function install_access()
  88         {
  89 //              $security_areas['SA_EXAMPLE'] = array(SS_EXAMPLE|100, _("Example security area."));
  90 //
  91 //              $security_sections = array(SS_EXAMPLE => _("Example module implementation"));
  92 //
  93 //              return array($security_areas, $security_sections);
  94         }
  95
  96         //
  97         //      Invoked for all modules before page header is displayed
  98         //
  99         function pre_header($fun_args)
 100         {
 101         }
 102         //
 103         //      Invoked for all modules before page footer is displayed
 104         //
 105         function pre_footer($fun_args)
 106         {
 107         }
 108
 109         //
 110         // Price in words. $doc_type is set to document type and can be used to suppress
 111         // price in words printing for selected document types.
 112         // Used instead of built in simple english price_in_words() function.
 113         //
 114         //      Returns: amount in words as string.
 115
 116         function price_in_words($amount, $doc_type)
 117         {
 118         }
 119         //
 120         // Exchange rate currency $curr as on date $date.
 121         // Keep in mind FA has internally implemented 3 exrate providers
 122         // If any of them supports your currency, you can simply use function below
 123         // with apprioprate provider set, otherwise implement your own.
 124         // Returns: $curr value in home currency units as a real number.
 125
 126         function retrieve_exrate($curr, $date)
 127         {
 128 //              $provider = 'ECB'; // 'ECB', 'YAHOO' or 'GOOGLE'
 129 //              return get_extern_rate($curr, $provider, $date);
 130                 return null;
 131         }
 132
 133         // External authentication
 134         // If used should return true after successfull athentication, false otherwise.
 135         function authenticate($login, $password)
 136         {
 137                 return null;
 138         }
 139         // Generic function called at the end of Tax Report (report 709)
 140         // Can be used e.g. for special database updates on every report printing
 141         // or to print special tax report footer
 142         //
 143         // Returns: nothing
 144         function tax_report_done()
 145         {
 146         }
 147         // Following database transaction hooks akcepts array of parameters:
 148         // 'cart' => transaction data
 149         // 'trans_type' => transaction type
 150
 151         function db_prewrite(&$cart, $trans_type)
 152         {
 153                 return true;
 154         }
 155
 156         function db_postwrite(&$cart, $trans_type)
 157         {
 158                 return true;
 159         }
 160
 161         function db_prevoid($trans_type, $trans_no)
 162         {
 163                 return true;
 164         }
 165         /*
 166                 This method is called after module install.
 167         */
 168         function install_extension($check_only=true)
 169         {
 170                 return true;
 171         }
 172         /*
 173                 This method is called after module uninstall.
 174         */
 175         function uninstall_extension($check_only=true)
 176         {
 177                 return true;
 178         }
 179         /*
 180                 This method is called on extension activation for company.
 181         */
 182         function activate_extension($company, $check_only=true)
 183         {
 184                 return true;
 185         }
 186         /*
 187                 This method is called when extension is deactivated for company.
 188         */
 189         function deactivate_extension($company, $check_only=true)
 190         {
 191                 return true;
 192         }
 193 }
 194
 195 /*
 196         Installs hooks provided by extension modules
 197 */
 198 function install_hooks()
 199 {
 200         global $path_to_root, $Hooks, $installed_extensions;
 201
 202         $Hooks = array();
 203
 204         // include current language related $Hooks object if locale file exists
 205         if (file_exists($path_to_root . "/lang/".$_SESSION['language']->code."/locale.inc"))
 206         {
 207                 include_once($path_to_root . "/lang/".$_SESSION['language']->code."/locale.inc");
 208                 $code = $_SESSION['language']->code;
 209                 $hook_class = 'hooks_'.$code;
 210                 $Hooks[$code] = new $hook_class;
 211                 unset($code, $hook_class);
 212         }
 213         // install hooks provided by active extensions
 214         foreach($installed_extensions as $ext) {
 215                         $hook_class = 'hooks_'.$ext['package'];
 216                         if ($ext['active'] && class_exists($hook_class)) {
 217                                 $Hooks[$ext['package']] = new $hook_class;
 218                         }
 219         }
 220 }
 221 /*
 222         Non active hooks are not included in $Hooks array, so we can use special function to
 223         activate.
 224 */
 225 function activate_hooks($ext, $comp)
 226 {
 227         global $Hooks;
 228
 229         $hooks = @$Hooks[$ext];
 230         if (!$hooks) {
 231                 $hookclass = 'hooks_'.$ext;
 232                 if (class_exists($hookclass))
 233                         $hooks = new $hookclass;
 234                 else
 235                         return true; // extension does not have hooks file
 236         }
 237         if (!$hooks)
 238                 return false;
 239         else
 240                 return $hooks->activate_extension($comp, false);
 241 }
 242 /*
 243         Calls hook $method defined in extension $ext (if any)
 244 */
 245 function hook_invoke($ext, $method, &$data, $opts=null)
 246 {
 247
 248         global $Hooks;
 249
 250         $ret = null;
 251         if (isset($Hooks[$ext]) && method_exists($Hooks[$ext], $method)) {
 252                 set_ext_domain('modules/'.$ext);
 253                 $ret = $Hooks[$ext]->$method($data, $opts);
 254                 set_ext_domain();
 255         }
 256         return $ret;
 257 }
 258
 259 /*
 260         Calls hook $methods defined in all extensions (if any)
 261 */
 262 function hook_invoke_all($method, &$data, $opts=null)
 263 {
 264
 265         global $Hooks;
 266
 267         $return = array();
 268         if (isset($Hooks))
 269         {
 270                 foreach($Hooks as $ext => $hook)
 271                         if (method_exists($hook, $method)) {
 272                                 set_ext_domain('modules/'.$ext);
 273                                 $result = $hook->$method($data, $opts);
 274                                 if (isset($result) && is_array($result)) {
 275                                         $return = array_merge_recursive($return, $result);
 276                                 } else if (isset($result)) {
 277                                         $return[] = $result;
 278                                         }
 279                                 set_ext_domain();
 280                         }
 281         }
 282         return $return;
 283 }
 284 /*
 285         Returns first non-null result returned from hook.
 286 */
 287 function hook_invoke_first($method, &$data, $opts=null)
 288 {
 289
 290         global $Hooks;
 291
 292         $result = null;
 293         foreach($Hooks as $ext => $hook) {
 294                 if (method_exists($hook, $method)) {
 295                         set_ext_domain('modules/'.$ext);
 296                         $result = $hook->$method($data, $opts);
 297                         set_ext_domain();
 298                         if (isset($result))
 299                                 break;
 300                 }
 301         }
 302         return $result;
 303 }
 304 /*
 305         Returns last non-null result returned from modules method. Helps implement hooks overriding by
 306         extensions installed later.
 307 */
 308 function hook_invoke_last($method, &$data, $opts=null)
 309 {
 310
 311         global $Hooks;
 312
 313         $result = null;
 314         $Reverse = array_reverse($Hooks);
 315         foreach($Reverse as $ext => $hook) {
 316                 if (method_exists($hook, $method)) {
 317                         set_ext_domain('modules/'.$ext);
 318                         $result = $hook->$method($data, $opts);
 319                         set_ext_domain();
 320                         if (isset($result))
 321                                 break;
 322                 }
 323         }
 324         return $result;
 325 }
 326 //------------------------------------------------------------------------------------------
 327 //      Database transaction hooks.
 328 //      $type - type of transaction (simplifies cart processing)
 329 //      $cart - transaction cart
 330 //      $args is optional array of parameters
 331 //
 332 // For FA 2.3 prewrite, postwrite and prevoid hooks are implemented for following transaction types:
 333 //
 334 // ST_BANKPAYMENT, ST_BANKDEPOSIT, ST_BANKTRANSFER,
 335 // ST_SALESORDER, ST_SALESQUOTE, ST_SALESINVOICE, ST_CUSTCREDIT, ST_CUSTPAYMENT, ST_CUSTDELIVERY,
 336 // ST_LOCTRANSFER, ST_INVADJUST,
 337 // ST_PURCHORDER, ST_SUPPINVOICE, ST_SUPPCREDIT, ST_SUPPAYMENT, ST_SUPPRECEIVE,
 338 // ST_WORKORDER, ST_MANUISSUE, ST_MANURECEIVE,
 339
 340 /*
 341         Invoked after transaction has been read from database to cart.
 342         Not implemented yet.
 343 */
 344 //function hook_db_postread(&$cart, $type)
 345 //{
 346 //      hook_invoke_all('db_postread', $cart, $type);
 347 //}
 348
 349 /*
 350         Invoked before transaction is written to database.
 351 */
 352 function hook_db_prewrite(&$cart, $type)
 353 {
 354         return hook_invoke_all('db_prewrite', $cart, $type);
 355 }
 356
 357 /*
 358         Invoked after transaction has been written to database.
 359 */
 360 function hook_db_postwrite(&$cart, $type)
 361 {
 362         return hook_invoke_all('db_postwrite', $cart, $type);
 363 }
 364 /*
 365         Invoked before transaction is voided
 366 */
 367 function hook_db_prevoid($type, $type_no)
 368 {
 369         return hook_invoke_all('db_prevoid', $type, $type_no);
 370 }
 371
 372 //-------------------------------------------------------------------------------------------
 373 //
 374 //      Various hooks
 375 //
 376 //      Alternative exchange rates feeds.
 377 //
 378 function hook_retrieve_exrate($currency, $date)
 379 {
 380         return hook_invoke_last('retrieve_exrate', $currency, $date);
 381 }
 382 //
 383 // Generic function called at the end of Tax Report (report 709)
 384 //
 385 function hook_tax_report_done()
 386 {
 387         return hook_invoke_all('tax_report_done', $dummy);
 388 }
 389 //
 390 //      Amount in words displayed on various documents (especially sales invoice)
 391 //
 392 function hook_price_in_words($amount, $document)
 393 {
 394         return hook_invoke_last('price_in_words', $amount, $document);
 395 }
 396 //
 397 //      Session handling hook. This is special case of hook class which have to be run before session is started.
 398 //      If fa_session_manager class is defined in any installed extension, this class provides session handling
 399 //      for application, otherwise standard php session handling is used.
 400 //
 401 function hook_session_start($company)
 402 {
 403         if (class_exists('fa_session_manager')) {
 404                 global $SessionManager;
 405                 $SessionManager = new fa_session_manager($company);
 406                 return $SessionManager->installed;
 407         }
 408         return false;
 409 }
 410 //
 411 //      Third party authentication modules.
 412 //      Returns true after successfull authentication, false otherwise, null if no login hook is defined.
 413 //
 414 function hook_authenticate($login, $password)
 415 {
 416         return hook_invoke_last('authenticate', $login, $password);
 417 }