forked from YetiForceCompany/YetiForceCRM
/
PBXManager.php
345 lines (319 loc) · 12.4 KB
/
PBXManager.php
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
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
188
189
190
191
192
193
194
195
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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
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
<?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.
* Contributor(s): YetiForce.com.
* *********************************************************************************** */
include_once 'include/CRMEntity.php';
require_once 'vtlib/Vtiger/Link.php';
include_once 'vtlib/Vtiger/Module.php';
include_once('vtlib/Vtiger/Menu.php');
require 'include/events/include.inc';
require_once 'include/utils/utils.php';
class PBXManager extends CRMEntity
{
protected $incominglinkLabel = 'Incoming Calls';
protected $tabId = 0;
protected $headerScriptLinkType = 'HEADERSCRIPT';
protected $dependentModules = array('Contacts', 'Leads', 'Accounts');
var $db;
var $table_name = 'vtiger_pbxmanager';
var $table_index = 'pbxmanagerid';
var $customFieldTable = Array('vtiger_pbxmanagercf', 'pbxmanagerid');
var $tab_name = Array('vtiger_crmentity', 'vtiger_pbxmanager', 'vtiger_pbxmanagercf');
var $tab_name_index = Array(
'vtiger_crmentity' => 'crmid',
'vtiger_pbxmanager' => 'pbxmanagerid',
'vtiger_pbxmanagercf' => 'pbxmanagerid');
var $list_fields = Array(
/* Format: Field Label => Array(tablename, columnname) */
// tablename should not have prefix 'vtiger_'
'Call Status' => Array('vtiger_pbxmanager', 'callstatus'),
'Customer' => Array('vtiger_pbxmanager', 'customer'),
'User' => Array('vtiger_pbxmanager', 'user'),
'Recording' => Array('vtiger_pbxmanager', 'recordingurl'),
'Start Time' => Array('vtiger_pbxmanager', 'starttime'),
);
var $list_fields_name = Array(
/* Format: Field Label => fieldname */
'Call Status' => 'callstatus',
'Customer' => 'customer',
'User' => 'user',
'Recording' => 'recordingurl',
'Start Time' => 'starttime',
);
// Make the field link to detail view
var $list_link_field = 'customernumber';
// For Popup listview and UI type support
var $search_fields = Array(
/* Format: Field Label => Array(tablename, columnname) */
// tablename should not have prefix 'vtiger_'
'Customer' => Array('vtiger_pbxmanager', 'customer'),
);
var $search_fields_name = Array(
/* Format: Field Label => fieldname */
'Customer' => 'customer',
);
// For Popup window record selection
var $popup_fields = Array('customernumber');
// For Alphabetical search
var $def_basicsearch_col = 'customer';
// Column value to use on detail view record text display
var $def_detailview_recname = 'customernumber';
// Used when enabling/disabling the mandatory fields for the module.
// Refers to vtiger_field.fieldname values.
// var $mandatory_fields = Array('assigned_user_id');
var $column_fields = Array();
var $default_order_by = 'customernumber';
var $default_sort_order = 'ASC';
function PBXManager()
{
$this->db = PearDatabase::getInstance();
$this->column_fields = getColumnFields('PBXManager');
}
/**
* Invoked when special actions are performed on the module.
* @param String Module name
* @param String Event Type (module.postinstall, module.disabled, module.enabled, module.preuninstall)
*/
function vtlib_handler($modulename, $event_type)
{
if ($event_type == 'module.postinstall') {
$this->addLinksForPBXManager();
$this->registerLookupEvents();
$this->addSettingsLinks();
$this->addActionMapping();
$this->setModuleRelatedDependencies();
$this->addUserExtensionField();
} else if ($event_type == 'module.disabled') {
$this->removeLinksForPBXManager();
$this->unregisterLookupEvents();
$this->removeSettingsLinks();
$this->removeActionMapping();
$this->unsetModuleRelatedDependencies();
} else if ($event_type == 'module.enabled') {
$this->addLinksForPBXManager();
$this->registerLookupEvents();
$this->addSettingsLinks();
$this->addActionMapping();
$this->setModuleRelatedDependencies();
} else if ($event_type == 'module.preuninstall') {
$this->removeLinksForPBXManager();
$this->unregisterLookupEvents();
$this->removeSettingsLinks();
$this->removeActionMapping();
$this->unsetModuleRelatedDependencies();
} else if ($event_type == 'module.preupdate') {
// TODO Handle actions before this module is updated.
} else if ($event_type == 'module.postupdate') {
// TODO Handle actions before this module is updated.
}
}
/** Function to handle module specific operations when saving a entity
*/
function save_module($module)
{
}
/**
* To add a phone extension field in user preferences page
*/
public function addUserExtensionField()
{
$log = vglobal('log');
$module = Vtiger_Module::getInstance('Users');
if ($module) {
$module->initTables();
$blockInstance = Vtiger_Block::getInstance('LBL_MORE_INFORMATION', $module);
if ($blockInstance) {
$fieldInstance = new Vtiger_Field();
$fieldInstance->name = 'phone_crm_extension';
$fieldInstance->label = 'CRM Phone Extension';
$fieldInstance->uitype = 11;
$fieldInstance->typeofdata = 'V~O';
$blockInstance->addField($fieldInstance);
}
}
$log->fatal('User Extension Field added');
}
/**
* To register phone lookup events
*/
public function registerLookupEvents()
{
$log = vglobal('log');
$adb = PearDatabase::getInstance();
$EventManager = new VTEventsManager($adb);
$createEvent = 'vtiger.entity.aftersave';
$deleteEVent = 'vtiger.entity.afterdelete';
$restoreEvent = 'vtiger.entity.afterrestore';
$batchSaveEvent = 'vtiger.batchevent.save';
$batchDeleteEvent = 'vtiger.batchevent.delete';
$handler_path = 'modules/PBXManager/PBXManagerHandler.php';
$className = 'PBXManagerHandler';
$batchEventClassName = 'PBXManagerBatchHandler';
$EventManager->registerHandler($createEvent, $handler_path, $className, '', '["VTEntityDelta"]');
$EventManager->registerHandler($deleteEVent, $handler_path, $className);
$EventManager->registerHandler($restoreEvent, $handler_path, $className);
$EventManager->registerHandler($batchSaveEvent, $handler_path, $batchEventClassName);
$EventManager->registerHandler($batchDeleteEvent, $handler_path, $batchEventClassName);
$log->fatal('Lookup Events Registered');
}
/**
* To add PBXManager module in module($this->dependentModules) related lists
*/
public function setModuleRelatedDependencies()
{
$log = vglobal('log');
$pbxmanager = Vtiger_Module::getInstance('PBXManager');
foreach ($this->dependentModules as $module) {
$moduleInstance = Vtiger_Module::getInstance($module);
$moduleInstance->setRelatedList($pbxmanager, "PBXManager", array(), 'get_dependents_list');
}
$log->fatal('Successfully added Module Related lists');
}
/**
* To remove PBXManager module from module($this->dependentModules) related lists
*/
public function unsetModuleRelatedDependencies()
{
$log = vglobal('log');
$pbxmanager = Vtiger_Module::getInstance('PBXManager');
foreach ($this->dependentModules as $module) {
$moduleInstance = Vtiger_Module::getInstance($module);
$moduleInstance->unsetRelatedList($pbxmanager, "PBXManager", 'get_dependents_list');
}
$log->fatal('Successfully removed Module Related lists');
}
/**
* To unregister phone lookup events
*/
public function unregisterLookupEvents()
{
$log = vglobal('log');
$adb = PearDatabase::getInstance();
$EventManager = new VTEventsManager($adb);
$className = 'PBXManagerHandler';
$batchEventClassName = 'PBXManagerBatchHandler';
$EventManager->unregisterHandler($className);
$EventManager->unregisterHandler($batchEventClassName);
$log->fatal('Lookup Events Unregistered');
}
/**
* To add a link in vtiger_links which is to load our PBXManagerJS.js
*/
public function addLinksForPBXManager()
{
$log = vglobal('log');
$handlerInfo = array('path' => 'modules/PBXManager/PBXManager.php',
'class' => 'PBXManager',
'method' => 'checkLinkPermission');
Vtiger_Link::addLink($this->tabId, $this->headerScriptLinkType, $this->incominglinkLabel, 'modules/PBXManager/resources/PBXManagerJS.js', '', '', $handlerInfo);
$log->fatal('Links added');
}
/**
* To remove link for PBXManagerJS.js from vtiger_links
*/
public function removeLinksForPBXManager()
{
$log = vglobal('log');
//Deleting Headerscripts links
Vtiger_Link::deleteLink($this->tabId, $this->headerScriptLinkType, $this->incominglinkLabel, 'modules/PBXManager/resources/PBXManagerJS.js');
$log->fatal('Links Removed');
}
/**
* To add Integration->PBXManager block in Settings page
*/
public function addSettingsLinks()
{
$log = vglobal('log');
$adb = PearDatabase::getInstance();
$integrationBlock = $adb->pquery('SELECT * FROM vtiger_settings_blocks WHERE label=?', array('LBL_INTEGRATION'));
$integrationBlockCount = $adb->num_rows($integrationBlock);
// To add Block
if ($integrationBlockCount > 0) {
$blockid = $adb->query_result($integrationBlock, 0, 'blockid');
} else {
$blockid = $adb->getUniqueID('vtiger_settings_blocks');
$sequenceResult = $adb->pquery("SELECT max(sequence) as sequence FROM vtiger_settings_blocks", array());
if ($adb->num_rows($sequenceResult)) {
$sequence = $adb->query_result($sequenceResult, 0, 'sequence');
}
$adb->pquery("INSERT INTO vtiger_settings_blocks(blockid, label, sequence) VALUES(?,?,?)", array($blockid, 'LBL_INTEGRATION', ++$sequence));
}
// To add a Field
$fieldid = $adb->getUniqueID('vtiger_settings_field');
$adb->pquery("INSERT INTO vtiger_settings_field(fieldid, blockid, name, iconpath, description, linkto, sequence, active)
VALUES(?,?,?,?,?,?,?,?)", array($fieldid, $blockid, 'LBL_PBXMANAGER', '', 'PBXManager module Configuration', 'index.php?module=PBXManager&parent=Settings&view=Index', 2, 0));
$log->fatal('Settings Block and Field added');
}
/**
* To delete Integration->PBXManager block in Settings page
*/
public function removeSettingsLinks()
{
$log = vglobal('log');
$adb = PearDatabase::getInstance();
$adb->pquery('DELETE FROM vtiger_settings_field WHERE name=?', array('LBL_PBXMANAGER'));
$log->fatal('Settings Field Removed');
}
/**
* To enable(ReceiveIncomingCall & MakeOutgoingCall) tool in profile
*/
public function addActionMapping()
{
$log = vglobal('log');
$adb = PearDatabase::getInstance();
$module = new Vtiger_Module();
$moduleInstance = $module->getInstance('PBXManager');
//To add actionname as ReceiveIncomingcalls
$maxActionIdresult = $adb->pquery('SELECT max(actionid+1) AS actionid FROM vtiger_actionmapping', array());
if ($adb->num_rows($maxActionIdresult)) {
$actionId = $adb->query_result($maxActionIdresult, 0, 'actionid');
}
$adb->pquery('INSERT INTO vtiger_actionmapping
(actionid, actionname, securitycheck) VALUES(?,?,?)', array($actionId, 'ReceiveIncomingCalls', 0));
$moduleInstance->enableTools('ReceiveIncomingcalls');
$log->fatal('ReceiveIncomingcalls ActionName Added');
//To add actionname as MakeOutgoingCalls
$maxActionIdresult = $adb->pquery('SELECT max(actionid+1) AS actionid FROM vtiger_actionmapping', array());
if ($adb->num_rows($maxActionIdresult)) {
$actionId = $adb->query_result($maxActionIdresult, 0, 'actionid');
}
$adb->pquery('INSERT INTO vtiger_actionmapping
(actionid, actionname, securitycheck) VALUES(?,?,?)', array($actionId, 'MakeOutgoingCalls', 0));
$moduleInstance->enableTools('MakeOutgoingCalls');
$log->fatal('MakeOutgoingCalls ActionName Added');
}
/**
* To remove(ReceiveIncomingCall & MakeOutgoingCall) tool from profile
*/
public function removeActionMapping()
{
$log = vglobal('log');
$adb = PearDatabase::getInstance();
$module = new Vtiger_Module();
$moduleInstance = $module->getInstance('PBXManager');
$moduleInstance->disableTools('ReceiveIncomingcalls');
$adb->pquery('DELETE FROM vtiger_actionmapping
WHERE actionname=?', array('ReceiveIncomingCalls'));
$log->fatal('ReceiveIncomingcalls ActionName Removed');
$moduleInstance->disableTools('MakeOutgoingCalls');
$adb->pquery('DELETE FROM vtiger_actionmapping
WHERE actionname=?', array('MakeOutgoingCalls'));
$log->fatal('MakeOutgoingCalls ActionName Removed');
}
public static function checkLinkPermission($linkData)
{
$module = new Vtiger_Module();
$moduleInstance = $module->getInstance('PBXManager');
if ($moduleInstance) {
return true;
} else {
return false;
}
}
}