includes/access_levels.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         Security sections groups various areas on both functionality and privilege levels.
  14         Often analytic inquires are available only for management, and configuration
  15         for administration or management staff. This is why we have those three
  16         section type inside near every FA module.
  17
  18         Section codes 0-99 are reserved for core FA functionalities.
  19         Every security section can contain up to 256 different areas.
  20         External modules can extend security roles system by adding rows to
  21         $security_sections and $security_areas using section codes >=100.
  22         Security areas and sections created by extension modules/plugins
  23         have dynamically assigned 3-byte integer codes. The highest byte is zero
  24         for sections/areas defined in this file, and extid+1 for those defined
  25         by extensions
  26 */
  27 define('SS_SADMIN',     1<<8);  // site admin
  28 define('SS_SETUP',      2<<8);  // company level setup
  29 define('SS_SPEC',       3<<8);  // special administration
  30
  31 define('SS_SALES_C',11<<8); // configuration
  32 define('SS_SALES',      12<<8); // transactions
  33 define('SS_SALES_A',13<<8); // analytic functions/reports/inquires
  34
  35 define('SS_PURCH_C',21<<8);
  36 define('SS_PURCH',      22<<8);
  37 define('SS_PURCH_A',23<<8);
  38
  39 define('SS_ITEMS_C',31<<8);
  40 define('SS_ITEMS',      32<<8);
  41 define('SS_ITEMS_A',33<<8);
  42
  43 define('SS_MANUF_C',41<<8);
  44 define('SS_MANUF',      42<<8);
  45 define('SS_MANUF_A',43<<8);
  46
  47 define('SS_DIM_C',      51<<8);
  48 define('SS_DIM',        52<<8);
  49 define('SS_DIM_A',      53<<8);
  50
  51 define('SS_GL_C',       61<<8);
  52 define('SS_GL',         62<<8);
  53 define('SS_GL_A',       63<<8);
  54
  55 $security_sections = array(
  56  SS_SADMIN => _("System administration"),
  57  SS_SETUP => _("Company setup"),
  58  SS_SPEC => _("Special maintenance"),
  59  SS_SALES_C => _("Sales configuration"),
  60  SS_SALES => _("Sales transactions"),
  61  SS_SALES_A => _("Sales related reports"),
  62  SS_PURCH_C => _("Purchase configuration"),
  63  SS_PURCH => _("Purchase transactions"),
  64  SS_PURCH_A => _("Purchase analytics"),
  65  SS_ITEMS_C => _("Inventory configuration"),
  66  SS_ITEMS => _("Inventory operations"),
  67  SS_ITEMS_A => _("Inventory analytics"),
  68  SS_MANUF_C => _("Manufacturing configuration"),
  69  SS_MANUF => _("Manufacturing transations"),
  70  SS_MANUF_A => _("Manufacturing analytics"),
  71  SS_DIM_C => _("Dimensions configuration"),
  72  SS_DIM => _("Dimensions"),
  73  SS_GL_C => _("Banking & GL configuration"),
  74  SS_GL => _("Banking & GL transactions"),
  75  SS_GL_A => _("Banking & GL analytics")
  76 );
  77
  78 /*
  79         This table stores security areas available in FA.
  80         Key is area identifier used to check user rights, values are
  81         codes stored for each role in security_roles table and description used
  82         in roles editor.
  83
  84         Set of allowed access areas codes is retrieved during user login from
  85         security_roles table, and cached in user profile.
  86
  87         Special value 'SA_OPEN' is used for publicly available pages like login/logout.
  88 */
  89 $security_areas =array(
  90 //
  91 //      Site administration
  92 //
  93         'SA_CREATECOMPANY' =>array(SS_SADMIN|1, _("Install/update companies")),
  94         'SA_CREATELANGUAGE' => array(SS_SADMIN|2, _("Install/update languages")),
  95         'SA_CREATEMODULES' => array(SS_SADMIN|3, _("Install/upgrade modules")),
  96         'SA_SOFTWAREUPGRADE' => array(SS_SADMIN|4, _("Software upgrades")),
  97 //
  98 //      Company setup
  99 //
 100         'SA_SETUPCOMPANY' => array(SS_SETUP|1, _("Company parameters")),
 101         'SA_SECROLES' => array(SS_SETUP|2, _("Access levels edition")),
 102         'SA_USERS' => array(SS_SETUP|3, _("Users setup")),
 103         'SA_POSSETUP' => array(SS_SETUP|4, _("Point of sales definitions")),
 104         'SA_PRINTERS' => array(SS_SETUP|5, _("Printers configuration")),
 105         'SA_PRINTPROFILE' => array(SS_SETUP|6, _("Print profiles")),
 106         'SA_PAYTERMS' => array(SS_SETUP|7, _("Payment terms")),
 107         'SA_SHIPPING' => array(SS_SETUP|8, _("Shipping ways")),
 108         'SA_CRSTATUS' => array(SS_SETUP|9, _("Credit status definitions changes")),
 109         'SA_INVENTORYLOCATION' => array(SS_SETUP|10, _("Inventory locations changes")),
 110         'SA_INVENTORYMOVETYPE'  => array(SS_SETUP|11, _("Inventory movement types")),
 111         'SA_WORKCENTRES' => array(SS_SETUP|12, _("Manufacture work centres")),
 112         'SA_FORMSETUP' => array(SS_SETUP|13, _("Forms setup")),
 113         'SA_CRMCATEGORY' => array(SS_SETUP|14, _("Contact categories")),
 114 //
 115 // Special and common functions
 116 //
 117         'SA_VOIDTRANSACTION' => array(SS_SPEC|1, _("Voiding transactions")),
 118         'SA_BACKUP' => array(SS_SPEC|2, _("Database backup/restore")),
 119         'SA_VIEWPRINTTRANSACTION' => array(SS_SPEC|3, _("Common view/print transactions interface")),
 120         'SA_ATTACHDOCUMENT' => array(SS_SPEC|4, _("Attaching documents")),
 121         'SA_SETUPDISPLAY' => array(SS_SPEC|5, _("Display preferences")), //???
 122         'SA_CHGPASSWD' => array(SS_SPEC|6, _("Password changes")), //???
 123
 124 //
 125 // Sales related functionality
 126 //
 127         'SA_SALESTYPES' => array(SS_SALES_C|1, _("Sales types")),
 128         'SA_SALESPRICE' => array(SS_SALES_C|2, _("Sales prices edition")),
 129         'SA_SALESMAN' => array(SS_SALES_C|3, _("Sales staff maintenance")),
 130         'SA_SALESAREA' => array(SS_SALES_C|4, _("Sales areas maintenance")),
 131         'SA_SALESGROUP' => array(SS_SALES_C|5, _("Sales groups changes")),
 132         'SA_STEMPLATE' => array(SS_SALES_C|6, _("Sales templates")),
 133         'SA_SRECURRENT' => array(SS_SALES_C|7, _("Recurrent invoices definitions")),
 134
 135         'SA_SALESTRANSVIEW' => array(SS_SALES|1,  _("Sales transactions view")),
 136         'SA_CUSTOMER' => array(SS_SALES|2,  _("Sales customer and branches changes")),
 137         'SA_SALESQUOTE' => array(SS_SALES|10, _("Sales quotations")),
 138         'SA_SALESORDER' => array(SS_SALES|3, _("Sales orders edition")),
 139         'SA_SALESDELIVERY' => array(SS_SALES|4, _("Sales deliveries edition")),
 140         'SA_SALESINVOICE' => array(SS_SALES|5, _("Sales invoices edition")),
 141         'SA_SALESCREDITINV' => array(SS_SALES|6, _("Sales credit notes against invoice")),
 142         'SA_SALESCREDIT' => array(SS_SALES|7, _("Sales freehand credit notes")),
 143         'SA_SALESPAYMNT' => array(SS_SALES|8, _("Customer payments entry")),
 144         'SA_SALESALLOC' => array(SS_SALES|9, _("Customer payments allocation")),
 145
 146         'SA_SALESANALYTIC' => array(SS_SALES_A|1, _("Sales analytical reports")),
 147         'SA_SALESBULKREP' => array(SS_SALES_A|2, _("Sales document bulk reports")),
 148         'SA_PRICEREP' => array(SS_SALES_A|3, _("Sales prices listing")),
 149         'SA_SALESMANREP' => array(SS_SALES_A|4, _("Sales staff listing")),
 150         'SA_CUSTBULKREP' => array(SS_SALES_A|5, _("Customer bulk listing")),
 151         'SA_CUSTSTATREP' => array(SS_SALES_A|6, _("Customer status report")),
 152         'SA_CUSTPAYMREP' => array(SS_SALES_A|7, _("Customer payments report")),
 153
 154 //
 155 // Purchase related functions
 156 //
 157         'SA_PURCHASEPRICING' => array(SS_PURCH_C|1, _("Purchase price changes")),
 158
 159         'SA_SUPPTRANSVIEW' => array(SS_PURCH|1, _("Supplier transactions view")),
 160         'SA_SUPPLIER' => array(SS_PURCH|2, _("Suppliers changes")),
 161         'SA_PURCHASEORDER' => array(SS_PURCH|3, _("Purchase order entry")),
 162         'SA_GRN' => array(SS_PURCH|4, _("Purchase receive")),
 163         'SA_SUPPLIERINVOICE' => array(SS_PURCH|5, _("Supplier invoices")),
 164         'SA_GRNDELETE' => array(SS_PURCH|9, _("Deleting GRN items during invoice entry")),
 165         'SA_SUPPLIERCREDIT' => array(SS_PURCH|6, _("Supplier credit notes")),
 166         'SA_SUPPLIERPAYMNT' => array(SS_PURCH|7, _("Supplier payments")),
 167         'SA_SUPPLIERALLOC' => array(SS_PURCH|8, _("Supplier payments allocations")),
 168
 169         'SA_SUPPLIERANALYTIC' => array(SS_PURCH_A|1, _("Supplier analytical reports")),
 170         'SA_SUPPBULKREP' => array(SS_PURCH_A|2, _("Supplier document bulk reports")),
 171         'SA_SUPPPAYMREP' => array(SS_PURCH_A|3, _("Supplier payments report")),
 172 //
 173 // Inventory
 174 //
 175         'SA_ITEM' => array(SS_ITEMS_C|1, _("Stock items add/edit")),
 176         'SA_SALESKIT' => array(SS_ITEMS_C|2, _("Sales kits")),
 177         'SA_ITEMCATEGORY' => array(SS_ITEMS_C|3, _("Item categories")),
 178         'SA_UOM' => array(SS_ITEMS_C|4, _("Units of measure")),
 179
 180         'SA_ITEMSSTATVIEW' => array(SS_ITEMS|1, _("Stock status view")),
 181         'SA_ITEMSTRANSVIEW' => array(SS_ITEMS|2, _("Stock transactions view")),
 182         'SA_FORITEMCODE' => array(SS_ITEMS|3, _("Foreign item codes entry")),
 183         'SA_LOCATIONTRANSFER' => array(SS_ITEMS|4, _("Inventory location transfers")),
 184         'SA_INVENTORYADJUSTMENT' => array(SS_ITEMS|5, _("Inventory adjustments")),
 185
 186         'SA_REORDER' => array(SS_ITEMS_A|1, _("Reorder levels")),
 187         'SA_ITEMSANALYTIC' => array(SS_ITEMS_A|2, _("Items analytical reports and inquiries")),
 188         'SA_ITEMSVALREP' => array(SS_ITEMS_A|3, _("Inventory valuation report")),
 189
 190 //
 191 // Manufacturing module
 192 //
 193         'SA_BOM' => array(SS_MANUF_C|1, _("Bill of Materials")),
 194
 195         'SA_MANUFTRANSVIEW' => array(SS_MANUF|1, _("Manufacturing operations view")),
 196         'SA_WORKORDERENTRY' => array(SS_MANUF|2, _("Work order entry")),
 197         'SA_MANUFISSUE' => array(SS_MANUF|3, _("Material issues entry")),
 198         'SA_MANUFRECEIVE' => array(SS_MANUF|4, _("Final product receive")),
 199         'SA_MANUFRELEASE' => array(SS_MANUF|5, _("Work order releases")),
 200
 201         'SA_WORKORDERANALYTIC' => array(SS_MANUF_A|1, _("Work order analytical reports and inquiries")),
 202         'SA_WORKORDERCOST' => array(SS_MANUF_A|2, _("Manufacturing cost inquiry")),
 203         'SA_MANUFBULKREP' => array(SS_MANUF_A|3, _("Work order bulk reports")),
 204         'SA_BOMREP' => array(SS_MANUF_A|4, _("Bill of materials reports")),
 205 //
 206 // Dimensions
 207 //
 208         'SA_DIMTAGS' => array(SS_DIM_C|1, _("Dimension tags")),
 209
 210         'SA_DIMTRANSVIEW' => array(SS_DIM|1, _("Dimension view")),
 211
 212         'SA_DIMENSION' => array(SS_DIM|2, _("Dimension entry")),
 213
 214         'SA_DIMENSIONREP' => array(SS_DIM|3, _("Dimension reports")),
 215 //
 216 // Banking and General Ledger
 217 //
 218         'SA_ITEMTAXTYPE' => array(SS_GL_C|1, _("Item tax type definitions")),
 219         'SA_GLACCOUNT' => array(SS_GL_C|2, _("GL accounts edition")),
 220         'SA_GLACCOUNTGROUP' => array(SS_GL_C|3, _("GL account groups")),
 221         'SA_GLACCOUNTCLASS' => array(SS_GL_C|4, _("GL account classes")),
 222         'SA_QUICKENTRY' => array(SS_GL_C|5, _("Quick GL entry definitions")),
 223         'SA_CURRENCY' => array(SS_GL_C|6, _("Currencies")),
 224         'SA_BANKACCOUNT' => array(SS_GL_C|7, _("Bank accounts")),
 225         'SA_TAXRATES' => array(SS_GL_C|8, _("Tax rates")),
 226         'SA_TAXGROUPS' => array(SS_GL_C|12, _("Tax groups")),
 227         'SA_FISCALYEARS' => array(SS_GL_C|9, _("Fiscal years maintenance")),
 228         'SA_GLSETUP' => array(SS_GL_C|10, _("Company GL setup")),
 229         'SA_GLACCOUNTTAGS' => array(SS_GL_C|11, _("GL Account tags")),
 230         'SA_MULTIFISCALYEARS' => array(SS_GL_C|13, _("Allow entry on non closed Fiscal years")),
 231
 232         'SA_BANKTRANSVIEW' => array(SS_GL|1, _("Bank transactions view")),
 233         'SA_GLTRANSVIEW' => array(SS_GL|2, _("GL postings view")),
 234         'SA_EXCHANGERATE' => array(SS_GL|3, _("Exchange rate table changes")),
 235         'SA_PAYMENT' => array(SS_GL|4, _("Bank payments")),
 236         'SA_DEPOSIT' => array(SS_GL|5, _("Bank deposits")),
 237         'SA_BANKTRANSFER' => array(SS_GL|6, _("Bank account transfers")),
 238         'SA_RECONCILE' => array(SS_GL|7, _("Bank reconciliation")),
 239         'SA_JOURNALENTRY' => array(SS_GL|8, _("Manual journal entries")),
 240         'SA_BANKJOURNAL' => array(SS_GL|11, _("Journal entries to bank related accounts")),
 241         'SA_BUDGETENTRY' => array(SS_GL|9, _("Budget edition")),
 242         'SA_STANDARDCOST' => array(SS_GL|10, _("Item standard costs")),
 243
 244         'SA_GLANALYTIC' => array(SS_GL_A|1, _("GL analytical reports and inquiries")),
 245         'SA_TAXREP' => array(SS_GL_A|2, _("Tax reports and inquiries")),
 246         'SA_BANKREP' => array(SS_GL_A|3, _("Bank reports and inquiries")),
 247         'SA_GLREP' => array(SS_GL_A|4, _("GL reports and inquiries")),
 248 );
 249 /*
 250         This function should be called whenever we want to extend core access level system
 251         with new security areas and/or sections i.e.:
 252         . on any page with non-standard security areas
 253         . in security roles editor
 254         The call should be placed between session.inc inclusion and page() call.
 255         Up to 155 security sections and 155 security areas for any extension can be installed.
 256 */
 257 function add_access_extensions()
 258 {
 259         global $security_areas, $security_sections, $installed_extensions;
 260
 261         foreach($installed_extensions as $extid => $ext) {
 262                 $scode = 100;
 263                 $acode = 100;
 264                 $accext = get_access_extensions($extid);
 265                 $extsections = $accext[1];
 266                 $extareas = $accext[0];
 267                 $extcode = $extid<<16;
 268
 269                 $trans = array();
 270                 foreach($extsections as $code =>$name) {
 271                         $trans[$code] = $scode<<8;
 272                         // reassign section codes
 273                         $security_sections[$trans[$code]|$extcode] = $name;
 274                         $scode++;
 275                 }
 276                 foreach($extareas as $code => $area) {
 277                         $section = $area[0]&0xff00;
 278                         // extension modules:
 279                         // if area belongs to nonstandard section
 280                         // use translated section codes and
 281                         // preserve lower part of area code
 282                         if (isset($trans[$section])) {
 283                                 $section = $trans[$section];
 284                         }
 285                                 // otherwise assign next available
 286                                 // area code >99
 287                         $area[0] = $extcode | $section | ($acode++);
 288                         $security_areas[$code] = $area;
 289                 }
 290         }
 291 }
 292 /*
 293         Helper function to retrieve extension access definitions in isolated environment.
 294 */
 295 function get_access_extensions($id) {
 296         global $path_to_root, $installed_extensions;
 297
 298         $ext = $installed_extensions[$id];
 299
 300         $security_sections = $security_areas = array();
 301
 302         if (isset($ext['acc_file']))
 303                 include($path_to_root.'/'.$ext['path'].'/'.$ext['acc_file']);
 304
 305         return array($security_areas, $security_sections);
 306 }
 307
 308 ?>