Feature 5388: Print Invoices (documents) list gets too long. Fixed by default 180...
[fa-stable.git] / includes / main.inc
index 943798011d4fe1666f3800a054bbb6b2492f9fa9..be058ed9293306e1fa933b09b09a1df1b8dd218d 100644 (file)
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  
     See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
 ***********************************************************************/
-    include_once($path_to_root . "/includes/db/connect_db.inc");
-
-    include_once($path_to_root . "/includes/reserved.inc");
-    include_once($path_to_root . "/includes/errors.inc");
-    include_once($path_to_root . "/includes/types.inc");
-    include_once($path_to_root . "/includes/systypes.inc");
-    include_once($path_to_root . "/includes/references.inc");
-    include_once($path_to_root . "/includes/prefs/sysprefs.inc");
-    include_once($path_to_root . "/includes/db/comments_db.inc");
-    include_once($path_to_root . "/includes/db/sql_functions.inc");
-
-    include_once($path_to_root . "/admin/db/users_db.inc");
-    include_once($path_to_root . "/includes/ui/ui_view.inc");
-    include_once($path_to_root . "/includes/ui/ui_controls.inc");
-    include_once($path_to_root . "/installed_extensions.php");
-       
-    function page($title, $no_menu=false, $is_index=false, $onload="", $js="", $script_only=false)
-    {
+include_once($path_to_root . "/includes/db/connect_db.inc");
 
-       global $path_to_root, $installed_extensions;
+include_once($path_to_root . "/admin/db/transactions_db.inc");
+include_once($path_to_root . "/includes/types.inc");
+include_once($path_to_root . "/includes/references.inc");
+include_once($path_to_root . "/includes/db/comments_db.inc");
+include_once($path_to_root . "/includes/db/sql_functions.inc");
+include_once($path_to_root . "/includes/db/audit_trail_db.inc");
 
-       $hide_menu = $no_menu;
+include_once($path_to_root . "/admin/db/users_db.inc");
+include_once($path_to_root . "/includes/ui/ui_view.inc");
+include_once($path_to_root . "/includes/ui/ui_controls.inc");
 
-               if ($no_menu==false && count($installed_extensions))
-               {
-                       global $applications;
-                       foreach ($installed_extensions as $ext)
-                       {
-                               $s = $applications['system'];
-                               array_pop($applications);
-                               $applications[$ext['name']] = $ext['title'];;
-                               $applications['system'] = $s;
-                       }       
-               }       
-
-       include($path_to_root . "/includes/page/header.inc");
-
-       page_header($title, $no_menu, $is_index, $onload, $js);
-               error_box();
-               if($script_only) {              
-                       echo '<noscript>';
-                       echo display_heading(_('This page is usable only with javascript enabled browsers.'));
-                       echo '</noscript>';
-                       div_start('_page_body', null, true);
-               } else {
-                       div_start('_page_body'); // whole page content for ajax reloading
-               }
-    }
+$page_nested = -1;
+// static js files path
+$js_path = $path_to_root.'/js/';
+// standard external js scripts included in all files
+$js_static = array('JsHttpRequest.js', 'behaviour.js', 'utils.js', 'inserts.js');
+// additional js source included in header
+$js_lib = $js_userlib = array();
+
+function page($title, $no_menu=false, $is_index=false, $onload="", $js="", $script_only=false, $css='')
+{
+
+       global $path_to_root, $page_security, $page_nested;
+
+       if (++$page_nested) return;
+
+       $hide_menu = $no_menu;
 
-    function end_page($no_menu=false, $is_index=false)
-    {
-       global $path_to_root, $Ajax;
+       include_once($path_to_root . "/includes/page/header.inc");
 
-       $hide_menu = $no_menu;
+       page_header($title, $no_menu, $is_index, $onload, $js, $css);
+       check_page_security($page_security);
+//     error_box();
+       if($script_only) {
+               echo '<noscript>';
+               echo display_heading(_('This page is usable only with javascript enabled browsers.'));
+               echo '</noscript>';
+               div_start('_page_body', null, true);
+       } else {
+               div_start('_page_body'); // whole page content for ajax reloading
+       }
+}
+
+function end_page($no_menu=false, $is_index=false, $final_screen=false, $type_no=0, $trans_no=0)
+{
+       global $path_to_root, $page_nested;
+
+       if ($page_nested-- > 0) return;
+
+       if (!$is_index && function_exists('hyperlink_back'))
+               hyperlink_back(true, $no_menu, $type_no, $trans_no, $final_screen);
+       div_end();      // end of _page_body section
+
+       include_once($path_to_root . "/includes/page/footer.inc");
+       page_footer($no_menu, $is_index);
+}
 
-               div_end();      // _page_body section
-       include($path_to_root . "/includes/page/footer.inc");
+function css_files_ensure_init() {
+       global $css_files, $path_to_root;
 
-       page_footer($no_menu, $is_index);
-    }
+       if (!isset($css_files))
+       {
+               $theme = user_theme();
+               $css_files = array();
+               $css_files[] = $path_to_root . "/themes/$theme/default.css";
+       }
+}
 
-    function flush_dir($path) {
-       $dir = opendir($path);
-       while(false !== ($fname = readdir($dir))) {
-               if($fname=='.' || $fname=='..' || $fname=='index.php') continue;
-               if(is_dir($path.'/'.$fname)) {
-                   flush_dir($path.'/'.$fname);
-                   @rmdir($path.'/'.$fname);
-               } else
-                   @unlink($path.'/'.$fname);
-       }
-    }
+function add_css_file($filename)
+{
+       global $css_files;
+       css_files_ensure_init();
+       $css_files[] = $filename;
+}
 
-    function cache_js_file($fpath, $text) 
-    {
-       global $go_debug;
+function cache_js_file($fpath, $text) 
+{
+       global $SysPrefs;
 
-       if(!$go_debug) $text = js_compress($text);
+       if (!$SysPrefs->go_debug) $text = js_compress($text);
 
-        $file = fopen($fpath, 'w');
+    $file = force_open($fpath);
        if (!$file) return false;
        if (!fwrite($file, $text)) return false;
        return fclose($file);
 
-    }
+}
+
+/*
+       Open file for writing with creration of subfolders if needed.
+*/
+function force_open($fname)
+{
+       $file = pathinfo($fname);
 
-    function add_js_file($filename) 
-    {
+       $path = $fname[0] == '/' ? '/' : '';
+       $tree = explode('/', $file['dirname']);
+       foreach($tree as $level) {
+               $path .= $level;
+               if (!file_exists($path)) {
+                       if (!mkdir($path)) {
+                               return null;
+                       }
+               }
+               $path .= '/';
+       }
+       return fopen($fname, 'w');
+}
+
+function add_js_file($filename) 
+{
          global $js_static;
 
          $search = array_search($filename, $js_static);
          if ($search === false || $search === null) // php>4.2.0 returns null
                $js_static[] = $filename;       
-    }
+}
 
-    function add_js_ufile($filename) 
-    {
+function add_js_ufile($filename) 
+{
          global $js_userlib;
 
          $search = array_search($filename, $js_userlib);
          if ($search === false || $search === null) // php>4.2.0 returns null
                $js_userlib[] = $filename;
-    }
+}
 
-    function add_js_source($text) 
-    {
+function add_js_source($text) 
+{
          global $js_lib;
-         
+
          $search = array_search($text, $js_lib);
          if ($search === false || $search === null) // php>4.2.0 returns null
                $js_lib[] = $text;
-    }
+}
 
 /**
  * Compresses the Javascript code for more efficient delivery.
@@ -153,10 +178,14 @@ function js_compress($sJS)
                $inNormalComment = false;
        
                //loop through line's characters and take out any literal strings, replace them with ___i___ where i is the index of this string
-               for($j=0;$j<strlen($line);$j++)
+               $len = strlen($line);
+               if (version_compare(PHP_VERSION, '7.0.0') >= 0) // uninitialized string offser error fix. @Braath Waate
+                       $line .= chr(32);
+               
+               for($j=0;$j<$len;$j++)
                {
-                       $c = substr($line,$j,1);
-                       $d = substr($line,$j,2);
+                       $c = $line[$j];         // this is _really_ faster than subst
+                       $d = $c.$line[$j+1];
        
                        //look for start of quote
                        if(!$inQuote && !$inComment)
@@ -270,37 +299,150 @@ function js_compress($sJS)
        }
        return $sJS;
 }
-//-----------------------------------------------------------------------------
-//     Inserts $elements into $array at position $index.
-//     $elements is list of any objects
-//
-function array_insert(&$array, $index, $elements)
+
+/*
+       Check if file can be updated, restoring subdirectories 
+       if needed. Returns 1 when no confilcts, -1 when file exists and is writable
+*/
+function check_write($path)
 {
-       if (!is_array($elements)) $elements = array($elements);
+       if ($path == ''//|| $path == '.' || $path == '..'
+       ) return 0;
 
-       $head  = array_splice($array, 0, $index);
-       $array = array_merge($head, $elements, $array);
+       return is_writable($path) ? (is_dir($path) ? 1 : -1) 
+               : (is_file($path) ? 0 : ($path == '.' || $path == '..' ? 0 : check_write(dirname($path))));
 }
 
-function array_remove(&$array, $index, $len=1)
+/*
+       Copies set of files. When $strict is set
+       also removes files from the $to which 
+       does not exists in $from directory but arelisted in $flist.
+*/
+function copy_files($flist, $from, $to, $strict=false)
 {
-       array_splice($array, $index, $len);
+       foreach ($flist as $file) {
+               if (file_exists($from.'/'.$file)) {
+                       if (!copy_file($file, $from, $to))
+                               return false;
+               } else if ($strict) {
+                               unlink($to.'/'.$file);
+               }
+       }
+       return true;
 }
 
-function array_replace(&$array, $index, $len, $elements)
+/*
+       Copies file from base to target directory, restoring subdirectories 
+       if needed.
+*/
+function copy_file($file, $from, $to)
 {
-       array_splice($array, $index, $len);
-       array_insert($array, $index, $elements);
+
+       if (!is_dir(dirname($file=='.' ? $to : ($to.'/'.$file)))) {
+               if (!copy_file(dirname($file), null, $to))
+                       return false;
+       }
+       if (!$from) {
+       //              error_log( 'dodanie katalogu '.$to.'/'.$file);
+               return @mkdir($file=='.' ? $to : ($to.'/'.$file));
+       }
+       else {
+       //              error_log( 'skopiowanie '.$to.'/'.$file);
+               return @copy($from.'/'.$file, $to.'/'.$file);
+       }
 }
+/*
+       Search for file, looking first for company specific version, then for 
+       version provided by any extension module, finally in main FA directory.
+       Also adds include path for any related files, and sets $local_path_to_root 
+       to enable local translation domains.
+       
+       Returns found file path or null.
+*/
+function find_custom_file($rep)
+{
+       global $installed_extensions, $path_to_root, $local_path_to_root;
 
-function array_append(&$array, $elements)
+       // customized per company version
+       $path = company_path();
+       $file = $path.$rep;
+       if (file_exists($file)) {
+               // add local include path
+               $local_path_to_root = $path;
+               set_include_path(dirname($file).PATH_SEPARATOR.get_include_path());
+               return $file;
+       }
+       // file added by active extension modules
+       if (count($installed_extensions) > 0)
+       {
+               $extensions = $installed_extensions;
+               foreach ($extensions as $ext)
+                       if (($ext['active'] && $ext['type'] == 'extension')) {
+                               $path = $path_to_root.'/'.$ext['path'];
+                               $file = $path.$rep;
+                               if (file_exists($file)) {
+                                       set_include_path($path.PATH_SEPARATOR.get_include_path());
+                                       $local_path_to_root = $path;
+                                       return $file;
+                               }
+                       }
+       }
+       // standard location
+       $file = $path_to_root.$rep;
+       if (file_exists($file))
+               return $file;
+
+       return null;
+}
+/*
+       
+       Protect against directory traversal.
+       Changes all not POSIX compatible chars to underscore.
+*/
+function clean_file_name($filename) {
+    $filename = str_replace(chr(0), '', $filename);
+    return preg_replace('/[^a-zA-Z0-9.\-_]/', '_', $filename);
+}
+
+/*
+       Simple random password generator.
+*/
+function generate_password()
+{
+       if (PHP_VERSION >= '5.3')
+               $bytes = openssl_random_pseudo_bytes(8, $cstrong);
+       else
+               $bytes = sprintf("08%x", mt_rand(0,0xffffffff));
+
+       return  base64_encode($bytes);
+}
+
+if (!function_exists('array_fill_keys')) // since 5.2
 {
-       foreach($elements as $key => $el) {
-               if(is_int($key))
-                       $array[] = $el;
-               else
-                       $array[$key] = $el;
+       function array_fill_keys($keys, $value)
+       {
+               return (object)array_combine($keys, array_fill(count($keys), $value));
        }
 }
 
-?>
\ No newline at end of file
+/*
+       This function aims to generate cryptographically strong random identifier.
+       Result identifier has length 4[strength/8/3] 
+*/
+function random_id($strength = 128)
+{
+       $n = ceil($strength/8);
+
+       if (function_exists('openssl_random_pseudo_bytes'))
+               $bin = openssl_random_pseudo_bytes($n, $cstrong);       // openssl on php 5.3 and up
+       else if (file_exists('/dev/urandom'))
+               $bin = file_get_contents('/dev/urandom', false, null, -1, $n);  // linux std random device
+       else {
+               $bin = '';
+               for($i=0; $i < $n; $i++)
+                       $bin .= chr(mt_rand(0, 255));   // Mersene Twister generator
+       }
+       $id = strtr(base64_encode($bin), '+/=', '-_x'); // see RFC 4648 Section 5
+
+       return $id;
+}