Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
<?php
/*+**********************************************************************************
* The contents of this file are subject to the vtiger CRM Public License Version 1.0
* ("License"); You may not use this file except in compliance with the License
* The Original Code is: vtiger CRM Open Source
* The Initial Developer of the Original Code is vtiger.
* Portions created by vtiger are Copyright (C) vtiger.
* All Rights Reserved.
************************************************************************************/
include_once('vtlib/Vtiger/Access.php');
include_once('vtlib/Vtiger/Block.php');
include_once('vtlib/Vtiger/Field.php');
include_once('vtlib/Vtiger/Filter.php');
include_once('vtlib/Vtiger/Profile.php');
include_once('vtlib/Vtiger/Menu.php');
include_once('vtlib/Vtiger/Link.php');
include_once('vtlib/Vtiger/Event.php');
include_once('vtlib/Vtiger/Webservice.php');
include_once('vtlib/Vtiger/Version.php');
require_once 'includes/runtime/Cache.php';
/**
* Provides API to work with vtiger CRM Module
* @package vtlib
*/
class Vtiger_ModuleBasic {
/** ID of this instance */
var $id = false;
var $name = false;
var $label = false;
var $version= 0;
var $minversion = false;
var $maxversion = false;
var $presence = 0;
var $ownedby = 0; // 0 - Sharing Access Enabled, 1 - Sharing Access Disabled
var $tabsequence = false;
var $parent = false;
var $customized = 0;
var $isentitytype = true; // Real module or an extension?
var $entityidcolumn = false;
var $entityidfield = false;
var $basetable = false;
var $basetableid=false;
var $customtable=false;
var $grouptable = false;
const EVENT_MODULE_ENABLED = 'module.enabled';
const EVENT_MODULE_DISABLED = 'module.disabled';
const EVENT_MODULE_POSTINSTALL = 'module.postinstall';
const EVENT_MODULE_PREUNINSTALL= 'module.preuninstall';
const EVENT_MODULE_PREUPDATE = 'module.preupdate';
const EVENT_MODULE_POSTUPDATE = 'module.postupdate';
/**
* Constructor
*/
function __construct() {
}
/**
* Initialize this instance
* @access private
*/
function initialize($valuemap) {
$this->id = $valuemap['tabid'];
$this->name=$valuemap['name'];
$this->label=$valuemap['tablabel'];
$this->version=$valuemap['version'];
$this->presence = $valuemap['presence'];
$this->ownedby = $valuemap['ownedby'];
$this->tabsequence = $valuemap['tabsequence'];
$this->parent = $valuemap['parent'];
$this->customized = $valuemap['customized'];
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
$this->isentitytype = $valuemap['isentitytype'];
if($this->isentitytype || $this->name == 'Users') {
// Initialize other details too
$this->initialize2();
}
}
/**
* Initialize more information of this instance
* @access private
*/
function initialize2() {
$entitydata = Vtiger_Functions::getEntityModuleInfo($this->name);
if ($entitydata) {
$this->basetable = $entitydata['tablename'];
$this->basetableid=$entitydata['entityidfield'];
}
}
/**
* Get unique id for this instance
* @access private
*/
function __getUniqueId() {
global $adb;
$result = $adb->query("SELECT MAX(tabid) AS max_seq FROM vtiger_tab");
$maxseq = $adb->query_result($result, 0, 'max_seq');
return ++$maxseq;
}
/**
* Get next sequence to use for this instance
* @access private
*/
function __getNextSequence() {
global $adb;
$result = $adb->pquery("SELECT MAX(tabsequence) AS max_tabseq FROM vtiger_tab", array());
$maxtabseq = $adb->query_result($result, 0, 'max_tabseq');
return ++$maxtabseq;
}
/**
* Initialize vtiger schema changes.
* @access private
*/
function __handleVtigerCoreSchemaChanges() {
// Add version column to the table first
Vtiger_Utils::AddColumn('vtiger_tab', 'version', ' VARCHAR(10)');
Vtiger_Utils::AddColumn('vtiger_tab', 'parent', ' VARCHAR(30)');
}
/**
* Create this module instance
* @access private
*/
function __create() {
global $adb;
self::log("Creating Module $this->name ... STARTED");
$this->id = $this->__getUniqueId();
if(!$this->tabsequence) $this->tabsequence = $this->__getNextSequence();
if(!$this->label) $this->label = $this->name;
$customized = 1; // To indicate this is a Custom Module
$this->__handleVtigerCoreSchemaChanges();
$adb->pquery("INSERT INTO vtiger_tab (tabid,name,presence,tabsequence,tablabel,modifiedby,
modifiedtime,customized,ownedby,version,parent) VALUES (?,?,?,?,?,?,?,?,?,?,?)",
Array($this->id, $this->name, $this->presence, -1, $this->label, NULL, NULL, $customized, $this->ownedby, $this->version,$this->parent));
$useisentitytype = $this->isentitytype? 1 : 0;
$adb->pquery('UPDATE vtiger_tab set isentitytype=? WHERE tabid=?',Array($useisentitytype, $this->id));
if(!Vtiger_Utils::CheckTable('vtiger_tab_info')) {
Vtiger_Utils::CreateTable(
'vtiger_tab_info',
'(tabid INT, prefname VARCHAR(256), prefvalue VARCHAR(256), FOREIGN KEY fk_1_vtiger_tab_info(tabid) REFERENCES vtiger_tab(tabid) ON DELETE CASCADE ON UPDATE CASCADE)',
true);
}
if($this->minversion) {
$tabResult = $adb->pquery("SELECT 1 FROM vtiger_tab_info WHERE tabid=? AND prefname='vtiger_min_version'", array($this->id));
if ($adb->num_rows($tabResult) > 0) {
$adb->pquery("UPDATE vtiger_tab_info SET prefvalue=? WHERE tabid=? AND prefname='vtiger_min_version'", array($this->minversion,$this->id));
} else {
$adb->pquery('INSERT INTO vtiger_tab_info(tabid, prefname, prefvalue) VALUES (?,?,?)', array($this->id, 'vtiger_min_version', $this->minversion));
}
}
if($this->maxversion) {
$tabResult = $adb->pquery("SELECT 1 FROM vtiger_tab_info WHERE tabid=? AND prefname='vtiger_max_version'", array($this->id));
if ($adb->num_rows($tabResult) > 0) {
$adb->pquery("UPDATE vtiger_tab_info SET prefvalue=? WHERE tabid=? AND prefname='vtiger_max_version'", array($this->maxversion,$this->id));
} else {
$adb->pquery('INSERT INTO vtiger_tab_info(tabid, prefname, prefvalue) VALUES (?,?,?)', array($this->id, 'vtiger_max_version', $this->maxversion));
}
}
Vtiger_Profile::initForModule($this);
self::syncfile();
if($this->isentitytype) {
Vtiger_Access::initSharing($this);
}
$moduleInstance = Vtiger_Module::getInstance($this->name);
$parentTab = $this->parent;
if (!empty($parentTab)) {
$menuInstance = Vtiger_Menu::getInstance($parentTab);
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
self::log("Creating Module $this->name ... DONE");
}
/**
* Update this instance
* @access private
*/
function __update() {
self::log("Updating Module $this->name ... DONE");
}
/**
* Delete this instance
* @access private
*/
function __delete() {
Vtiger_Module::fireEvent($this->name,
Vtiger_Module::EVENT_MODULE_PREUNINSTALL);
global $adb;
if($this->isentitytype) {
$this->unsetEntityIdentifier();
$this->deleteRelatedLists();
}
$adb->pquery("DELETE FROM vtiger_tab WHERE tabid=?", Array($this->id));
self::log("Deleting Module $this->name ... DONE");
}
/**
* Update module version information
* @access private
*/
function __updateVersion($newversion) {
$this->__handleVtigerCoreSchemaChanges();
global $adb;
$adb->pquery("UPDATE vtiger_tab SET version=? WHERE tabid=?", Array($newversion, $this->id));
$this->version = $newversion;
self::log("Updating version to $newversion ... DONE");
}
/**
* Save this instance
*/
function save() {
if($this->id) $this->__update();
else $this->__create();
return $this->id;
}
/**
* Delete this instance
*/
function delete() {
if($this->isentitytype) {
Vtiger_Access::deleteSharing($this);
Vtiger_Access::deleteTools($this);
Vtiger_Filter::deleteForModule($this);
Vtiger_Block::deleteForModule($this);
if(method_exists($this, 'deinitWebservice')) {
$this->deinitWebservice();
}
}
$this->__delete();
Vtiger_Profile::deleteForModule($this);
Vtiger_Link::deleteAll($this->id);
Vtiger_Menu::detachModule($this);
self::syncfile();
}
/**
* Initialize table required for the module
* @param String Base table name (default modulename in lowercase)
* @param String Base table column (default modulenameid in lowercase)
*
* Creates basetable, customtable, grouptable <br>
* customtable name is basetable + 'cf'<br>
* grouptable name is basetable + 'grouprel'<br>
*/
function initTables($basetable=false, $basetableid=false) {
$this->basetable = $basetable;
$this->basetableid=$basetableid;
// Initialize tablename and index column names
$lcasemodname = strtolower($this->name);
if(!$this->basetable) $this->basetable = "vtiger_$lcasemodname";
if(!$this->basetableid)$this->basetableid=$lcasemodname . "id";
if(!$this->customtable)$this->customtable = $this->basetable . "cf";
if(!$this->grouptable)$this->grouptable = $this->basetable."grouprel";
if(!$this->fieldtable)$this->fieldtable = $this->basetable."_user_field";
Vtiger_Utils::CreateTable($this->basetable,"($this->basetableid INT(19) PRIMARY KEY)",true);
Vtiger_Utils::CreateTable($this->customtable,"($this->basetableid INT(19) PRIMARY KEY)", true);
Vtiger_Utils::CreateTable($this->fieldtable,"(recordid INT(25) NOT NULL,userid INT(25) NOT NULL,starred VARCHAR(100) NULL DEFAULT NULL)",true);
Vtiger_Utils::CreateTable($this->grouptable, "($this->basetableid INT PRIMARY KEY, groupname varchar(100))",true);
}
}
/**
* Set entity identifier field for this module
* @param Vtiger_Field Instance of field to use
*/
function setEntityIdentifier($fieldInstance) {
global $adb;
if($this->basetableid) {
if(!$this->entityidfield) $this->entityidfield = $this->basetableid;
if(!$this->entityidcolumn)$this->entityidcolumn= $this->basetableid;
}
if ($this->entityidfield && $this->entityidcolumn) {
$result = $adb->pquery("SELECT tabid FROM vtiger_entityname WHERE tablename=? AND tabid=?", array($fieldInstance->table, $this->id));
if ($adb->num_rows($result) == 0) {
$adb->pquery("INSERT INTO vtiger_entityname(tabid, modulename, tablename, fieldname, entityidfield, entityidcolumn) VALUES(?,?,?,?,?,?)", Array($this->id, $this->name, $fieldInstance->table, $fieldInstance->name, $this->entityidfield, $this->entityidcolumn));
self::log("Setting entity identifier ... DONE");
} else {
$adb->pquery("UPDATE vtiger_entityname SET fieldname=?,entityidfield=?,entityidcolumn=? WHERE tablename=? AND tabid=?", array($fieldInstance->name, $this->entityidfield, $this->entityidcolumn, $fieldInstance->table, $this->id));
self::log("Updating entity identifier ... DONE");
}
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
}
}
/**
* Unset entity identifier information
*/
function unsetEntityIdentifier() {
global $adb;
$adb->pquery("DELETE FROM vtiger_entityname WHERE tabid=?", Array($this->id));
self::log("Unsetting entity identifier ... DONE");
}
/**
* Delete related lists information
*/
function deleteRelatedLists() {
global $adb;
$adb->pquery("DELETE FROM vtiger_relatedlists WHERE tabid=?", Array($this->id));
self::log("Deleting related lists ... DONE");
}
/**
* Delete links information
*/
function deleteLinks() {
global $adb;
$adb->pquery("DELETE FROM vtiger_links WHERE tabid=?", Array($this->id));
self::log("Deleting links ... DONE");
}
/**
* Configure default sharing access for the module
* @param String Permission text should be one of ['Public_ReadWriteDelete', 'Public_ReadOnly', 'Public_ReadWrite', 'Private']
*/
function setDefaultSharing($permission_text='Public_ReadWriteDelete') {
Vtiger_Access::setDefaultSharing($this, $permission_text);
}
/**
* Allow module sharing control
*/
function allowSharing() {
Vtiger_Access::allowSharing($this, true);
}
/**
* Disallow module sharing control
*/
function disallowSharing() {
Vtiger_Access::allowSharing($this, false);
}
/**
* Enable tools for this module
* @param mixed String or Array with value ['Import', 'Export', 'Merge']
*/
function enableTools($tools) {
if(is_string($tools)) {
$tools = Array(0 => $tools);
}
foreach($tools as $tool) {
Vtiger_Access::updateTool($this, $tool, true);
}
}
/**
* Disable tools for this module
* @param mixed String or Array with value ['Import', 'Export', 'Merge']
*/
function disableTools($tools) {
if(is_string($tools)) {
$tools = Array(0 => $tools);
}
foreach($tools as $tool) {
Vtiger_Access::updateTool($this, $tool, false);
}
}
/**
* Add block to this module
* @param Vtiger_Block Instance of block to add
*/
function addBlock($blockInstance) {
$blockInstance->save($this);
return $this;
}
/**
* Add filter to this module
* @param Vtiger_Filter Instance of filter to add
*/
function addFilter($filterInstance) {
$filterInstance->save($this);
return $this;
}
/**
* Get all the fields of the module or block
* @param Vtiger_Block Instance of block to use to get fields, false to get all the block fields
*/
function getFields($blockInstance=false) {
$fields = false;
if($blockInstance) $fields = Vtiger_Field::getAllForBlock($blockInstance, $this);
else $fields = Vtiger_Field::getAllForModule($this);
return $fields;
}
/**
* Helper function to log messages
* @param String Message to log
* @param Boolean true appends linebreak, false to avoid it
* @access private
*/
static function log($message, $delimit=true) {
Vtiger_Utils::Log($message, $delimit);
}
/**
* Synchronize the menu information to flat file
* @access private
*/
static function syncfile() {
self::log("Updating tabdata file ... ", false);
create_tab_data_file();
self::log("DONE");
}
}
?>