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 //              set_ext_domain('modules/example');        // set text domain for gettext
  71 //              $app->add_application(new example_class); // add menu tab defined by example_class
  72 //              set_ext_domain();
  73         }
  74         //
  75         //      Install additonal menu options provided by extension
  76         //
  77         function install_options($app) {
  78 //              global $path_to_root;
  79 //              set_ext_domain('modules/example');
  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 //              set_ext_domain();
  86         }
  87         //
  88         // Price in words. $doc_type is set to document type and can be used to suppress
  89         // price in words printing for selected document types.
  90         // Used instead of built in simple english price_in_words() function.
  91         //
  92         //      Returns: amount in words as string.
  93
  94         function price_in_words($amount, $doc_type)
  95         {
  96         }
  97
  98         //
  99         // Exchange rate currency $curr as on date $date.
 100         // Keep in mind FA has internally implemented 3 exrate providers
 101         // If any of them supports your currency, you can simply use function below
 102         // with apprioprate provider set, otherwise implement your own.
 103         // Returns: $curr value in home currency units as a real number.
 104
 105         function retrieve_exrate($curr, $date)
 106         {
 107 //              $provider = 'ECB'; // 'ECB', 'YAHOO' or 'GOOGLE'
 108 //              return get_extern_rate($curr, $provider, $date);
 109                 return null;
 110         }
 111
 112         // Generic function called at the end of Tax Report (report 709)
 113         // Can be used e.g. for special database updates on every report printing
 114         // or to print special tax report footer
 115         //
 116         // Returns: nothing
 117         function tax_report_done()
 118         {
 119         }
 120         // Following database transaction hooks akcepts array of parameters:
 121         // 'cart' => transaction data
 122         // 'trans_type' => transaction type
 123
 124         function db_prewrite(&$cart, $trans_type)
 125         {
 126                 return true;
 127         }
 128
 129         function db_postwrite(&$cart, $trans_type)
 130         {
 131                 return true;
 132         }
 133
 134         function db_prevoid($trans_type, $trans_no)
 135         {
 136                 return true;
 137         }
 138         /*
 139                 This method is called after module install.
 140         */
 141         function install_extension($check_only=true)
 142         {
 143                 return true;
 144         }
 145         /*
 146                 This method is called after module uninstall.
 147         */
 148         function uninstall_extension($check_only=true)
 149         {
 150                 return true;
 151         }
 152         /*
 153                 This method is called on extension activation for company.
 154         */
 155         function activate_extension($company, $check_only=true)
 156         {
 157                 return true;
 158         }
 159         /*
 160                 This method is called when extension is deactivated for company.
 161         */
 162         function deactivate_extension($company, $check_only=true)
 163         {
 164                 return true;
 165         }
 166 }
 167
 168 /*
 169         Installs hooks provided by extension modules
 170 */
 171 function install_hooks() {
 172         global $path_to_root, $Hooks, $installed_extensions;
 173
 174         $Hooks = array();
 175
 176         // include current language related $Hooks object if locale file exists
 177         if (file_exists($path_to_root . "/lang/".$_SESSION['language']->code."/locale.inc"))
 178         {
 179                 include_once($path_to_root . "/lang/".$_SESSION['language']->code."/locale.inc");
 180                 $code = $_SESSION['language']->code;
 181                 $hook_class = 'hooks_'.$code;
 182                 $Hooks[$code] = new $hook_class;
 183                 unset($code, $hook_class);
 184         }
 185         // install hooks provided by active extensions
 186         foreach($installed_extensions as $ext) {
 187                         $hook_class = 'hooks_'.$ext['package'];
 188                         if ($ext['active'] && class_exists($hook_class)) {
 189                                 $Hooks[$ext['package']] = new $hook_class;
 190                         }
 191         }
 192 }
 193 /*
 194         Non active hooks are not included in $Hooks array, so we can use special function to
 195         activate.
 196 */
 197 function activate_hooks($ext, $comp) {
 198         global $Hooks;
 199
 200         $hooks = @$Hooks[$ext];
 201         if (!$hooks) {
 202                 $hookclass = 'hooks_'.$ext;
 203                 if (class_exists($hookclass))
 204                         $hooks = new $hookclass;
 205                 else
 206                         return true; // extension does not have hooks file
 207         }
 208         if (!$hooks)
 209                 return false;
 210         else
 211                 return $hooks->activate_extension($comp, false);
 212 }
 213 /*
 214         Calls hook $method defined in extension $ext (if any)
 215 */
 216 function hook_invoke($ext, $method, &$data, $opts=null) {
 217
 218         global $Hooks;
 219
 220         $ret = null;
 221         if (isset($Hooks[$ext]) && method_exists($Hooks[$ext], $method)) {
 222                 set_ext_domain('modules/'.$ext);
 223                 $ret = $Hooks[$ext]->$method($data, $opts);
 224                 set_ext_domain();
 225         }
 226         return $ret;
 227 }
 228
 229 /*
 230         Calls hook $methods defined in all extensions (if any)
 231 */
 232 function hook_invoke_all($method, &$data, $opts=null) {
 233
 234         global $Hooks;
 235
 236         $result = array();
 237         foreach($Hooks as $ext => $hook)
 238                 if (method_exists($hook, $method)) {
 239                         set_ext_domain('modules/'.$ext);
 240                         $result = $hook->$method($data, $opts);
 241                         if (isset($result) && is_array($result)) {
 242                                 $return = array_merge_recursive($return, $result);
 243                         } else if (isset($result)) {
 244                                 $return[] = $result;
 245                                 }
 246                 }
 247         set_ext_domain();
 248         return $result;
 249 }
 250 /*
 251         Returns first non-null result returned from hook.
 252 */
 253 function hook_invoke_first($method, &$data, $opts=null) {
 254
 255         global $Hooks;
 256
 257         $result = null;
 258         foreach($Hooks as $ext => $hook) {
 259                 if (method_exists($hook, $method)) {
 260                         set_ext_domain('modules/'.$ext);
 261                         $result = $hook->$method($data, $opts);
 262                         if (isset($result))
 263                                 break;
 264                 }
 265         }
 266         set_ext_domain();
 267         return $result;
 268 }
 269 /*
 270         Returns result of last hook installed. Helps implement hooks overriding by
 271         extensions installed later.
 272
 273 */
 274 function hook_invoke_last($method, &$data, $opts=null) {
 275
 276         global $Hooks;
 277
 278         $found = false;
 279         foreach($Hooks as $ext => $hook) {
 280                 if (method_exists($hook, $method)) {
 281                         $found = $ext;
 282                 }
 283         }
 284         $ret = null;
 285         if ($found) {
 286                 set_ext_domain('modules/'.$found);
 287                 $ret = $Hooks[$found]->$method($data, $opts);
 288                 set_ext_domain();
 289         }
 290         return $ret;
 291 }
 292 //------------------------------------------------------------------------------------------
 293 //      Database transaction hooks.
 294 //      $type - type of transaction (simplifies cart processing)
 295 //      $cart - transaction cart
 296 //      $args is optional array of parameters
 297 //
 298 // For FA 2.3 prewrite, postwrite and prevoid hooks are implemented for following transaction types:
 299 //
 300 // ST_BANKPAYMENT, ST_BANKDEPOSIT, ST_BANKTRANSFER,
 301 // ST_SALESORDER, ST_SALESQUOTE, ST_SALESINVOICE, ST_CUSTCREDIT, ST_CUSTPAYMENT, ST_CUSTDELIVERY,
 302 // ST_LOCTRANSFER, ST_INVADJUST,
 303 // ST_PURCHORDER, ST_SUPPINVOICE, ST_SUPPCREDIT, ST_SUPPAYMENT, ST_SUPPRECEIVE,
 304 // ST_WORKORDER, ST_MANUISSUE, ST_MANURECEIVE,
 305
 306 /*
 307         Invoked after transaction has been read from database to cart.
 308         Not implemented yet.
 309 */
 310 //function hook_db_postread(&$cart, $type)
 311 //{
 312 //      hook_invoke_all('db_postread', $cart, $type);
 313 //}
 314
 315 /*
 316         Invoked before transaction is written to database.
 317 */
 318 function hook_db_prewrite(&$cart, $type)
 319 {
 320         return hook_invoke_all('db_prewrite', $cart, $type);
 321 }
 322
 323 /*
 324         Invoked after transaction has been written to database.
 325 */
 326 function hook_db_postwrite(&$cart, $type)
 327 {
 328         return hook_invoke_all('db_postwrite', $cart, $type);
 329 }
 330 /*
 331         Invoked before transaction is voided
 332 */
 333 function hook_db_prevoid($type, $type_no)
 334 {
 335         return hook_invoke_all('db_prevoid', $type, $type_no);
 336 }
 337
 338 //-------------------------------------------------------------------------------------------
 339 //
 340 //      Various hooks
 341 //
 342 //      Alternative exchange rates feeds.
 343 //
 344 function hook_retrieve_exrate($currency, $date)
 345 {
 346         return hook_invoke_last('retrieve_exrate', $currency, $date);
 347 }
 348 //
 349 // Generic function called at the end of Tax Report (report 709)
 350 //
 351 function hook_tax_report_done()
 352 {
 353         return hook_invoke_all('tax_report_done', $dummy);
 354 }
 355 //
 356 //      Amount in words displayed on various documents (especially sales invoice)
 357 //
 358 function hook_price_in_words($amount, $document)
 359 {
 360         return hook_invoke_last('price_in_words', $amount, $document);
 361 }
 362 //
 363 //      Session handling hook. This is special case of hook class which have to be run before session is started.
 364 //      If fa_session_manager class is defined in any installed extension, this class provides session handling
 365 //      for application, otherwise standard php session handling is used.
 366 //
 367 function hook_session_start($company)
 368 {
 369         if (class_exists('fa_session_manager')) {
 370                 global $SessionManager;
 371                 $SessionManager = new fa_session_manager($company);
 372                 return $SessionManager->installed;
 373         }
 374         return false;
 375 }