Cleanup again.
[fa-stable.git] / includes / hooks.inc
index c279b4afc4371ded9621aa6548884168a729d8bc..b27fc35501788654afcd15ab69df50d23d5ad73c 100644 (file)
@@ -66,24 +66,46 @@ class hooks {
        //
        //      Install additional tabs provided by extension
        //
-       function install_tabs($app) {
-//             set_ext_domain('modules/example');        // set text domain for gettext
+       function install_tabs($app)
+       {
 //             $app->add_application(new example_class); // add menu tab defined by example_class
-//             set_ext_domain();
        }
        //
        //      Install additonal menu options provided by extension
        //
-       function install_options($app) {
+       function install_options($app)
+       {
 //             global $path_to_root;
-//             set_ext_domain('modules/example');
+//
 //             switch($app->id) {
 //                     case 'orders':
 //                             $app->add_rapp_function( 0, _("&Example option"), 
 //                                     $path_to_root.'/modules/example/example.php?', 'SA_OPEN');
 //             }
-//             set_ext_domain();
        }
+       
+       function install_access()
+       {
+//             $security_areas['SA_EXAMPLE'] = array(SS_EXAMPLE|100, _("Example security area."));
+//
+//             $security_sections = array(SS_EXAMPLE => _("Example module implementation"));
+//
+//             return array($security_areas, $security_sections);
+       }
+
+       //
+       //      Invoked for all modules before page header is displayed
+       //
+       function pre_header($fun_args)
+       {
+       }
+       //
+       //      Invoked for all modules before page footer is displayed
+       //
+       function pre_footer($fun_args)
+       {
+       }
+
        //
        // Price in words. $doc_type is set to document type and can be used to suppress 
        // price in words printing for selected document types.
@@ -94,7 +116,6 @@ class hooks {
        function price_in_words($amount, $doc_type)
        {
        }
-
        //
        // Exchange rate currency $curr as on date $date.
        // Keep in mind FA has internally implemented 3 exrate providers
@@ -109,6 +130,12 @@ class hooks {
                return null;
        }
 
+       // External authentication
+       // If used should return true after successfull athentication, false otherwise.
+       function authenticate($login, $password)
+       {
+               return null;
+       }
        // Generic function called at the end of Tax Report (report 709)
        // Can be used e.g. for special database updates on every report printing
        // or to print special tax report footer 
@@ -164,19 +191,12 @@ class hooks {
                return true;
        }
 }
-//
-// include all extensions hook files.
-//
-foreach ($installed_extensions as $ext)
-{
-       if (file_exists($path_to_root.'/'.$ext['path'].'/hooks.php'))
-               include_once($path_to_root.'/'.$ext['path'].'/hooks.php');
-}
 
 /*
        Installs hooks provided by extension modules
 */
-function install_hooks() {
+function install_hooks()
+{
        global $path_to_root, $Hooks, $installed_extensions;
 
        $Hooks = array();
@@ -202,7 +222,8 @@ function install_hooks() {
        Non active hooks are not included in $Hooks array, so we can use special function to 
        activate.
 */
-function activate_hooks($ext, $comp) {
+function activate_hooks($ext, $comp)
+{
        global $Hooks;
        
        $hooks = @$Hooks[$ext];
@@ -221,7 +242,8 @@ function activate_hooks($ext, $comp) {
 /*
        Calls hook $method defined in extension $ext (if any)
 */
-function hook_invoke($ext, $method, &$data, $opts=null) {
+function hook_invoke($ext, $method, &$data, $opts=null)
+{
 
        global $Hooks;
 
@@ -237,28 +259,33 @@ function hook_invoke($ext, $method, &$data, $opts=null) {
 /*
        Calls hook $methods defined in all extensions (if any)
 */
-function hook_invoke_all($method, &$data, $opts=null) {
+function hook_invoke_all($method, &$data, $opts=null)
+{
 
        global $Hooks;
        
-       $result = array();
-       foreach($Hooks as $ext => $hook)
-               if (method_exists($hook, $method)) {
-                       set_ext_domain('modules/'.$ext);
-                       $result = $hook->$method($data, $opts);
-                       if (isset($result) && is_array($result)) {
-                               $return = array_merge_recursive($return, $result);
-                       } else if (isset($result)) {
-                               $return[] = $result;
-                               }
-               }
-       set_ext_domain();
-       return $result;
+       $return = array();
+       if (isset($Hooks))
+       {
+               foreach($Hooks as $ext => $hook)
+                       if (method_exists($hook, $method)) {
+                               set_ext_domain('modules/'.$ext);
+                               $result = $hook->$method($data, $opts);
+                               if (isset($result) && is_array($result)) {
+                                       $return = array_merge_recursive($return, $result);
+                               } else if (isset($result)) {
+                                       $return[] = $result;
+                                       }
+                               set_ext_domain();
+                       }
+       }
+       return $return;
 }
 /*
        Returns first non-null result returned from hook.
 */
-function hook_invoke_first($method, &$data, $opts=null) {
+function hook_invoke_first($method, &$data, $opts=null)
+{
 
        global $Hooks;
        
@@ -267,35 +294,34 @@ function hook_invoke_first($method, &$data, $opts=null) {
                if (method_exists($hook, $method)) {
                        set_ext_domain('modules/'.$ext);
                        $result = $hook->$method($data, $opts);
+                       set_ext_domain();
                        if (isset($result))
                                break;
                }
        }
-       set_ext_domain();
        return $result;
 }
 /*
-       Returns result of last hook installed. Helps implement hooks overriding by 
+       Returns last non-null result returned from modules method. Helps implement hooks overriding by 
        extensions installed later.
-       
 */
-function hook_invoke_last($method, &$data, $opts=null) {
+function hook_invoke_last($method, &$data, $opts=null)
+{
 
        global $Hooks;
 
-       $found = false;
-       foreach($Hooks as $ext => $hook) {
+       $result = null;
+       $Reverse = array_reverse($Hooks);
+       foreach($Reverse as $ext => $hook) {
                if (method_exists($hook, $method)) {
-                       $found = $ext;
+                       set_ext_domain('modules/'.$ext);
+                       $result = $hook->$method($data, $opts);
+                       set_ext_domain();
+                       if (isset($result))
+                               break;
                }
        }
-       $ret = null;
-       if ($found) {
-               set_ext_domain('modules/'.$found);
-               $ret = $Hooks[$found]->$method($data, $opts);
-               set_ext_domain();
-       }
-       return $ret;
+       return $result;
 }
 //------------------------------------------------------------------------------------------
 //     Database transaction hooks.
@@ -367,3 +393,25 @@ function hook_price_in_words($amount, $document)
 {
        return hook_invoke_last('price_in_words', $amount, $document);
 }
+//
+//     Session handling hook. This is special case of hook class which have to be run before session is started.
+//     If fa_session_manager class is defined in any installed extension, this class provides session handling
+//     for application, otherwise standard php session handling is used.
+//
+function hook_session_start($company)
+{
+       if (class_exists('fa_session_manager')) {
+               global $SessionManager;
+               $SessionManager = new fa_session_manager($company);
+               return $SessionManager->installed;
+       }
+       return false;
+}
+//
+//     Third party authentication modules.
+//     Returns true after successfull authentication, false otherwise, null if no login hook is defined.
+//
+function hook_authenticate($login, $password)
+{
+       return hook_invoke_last('authenticate', $login, $password);
+}