Newer
Older
<?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.
*************************************************************************************/
class VtigerModuleOperation extends WebserviceEntityOperation {
protected $tabId;
protected $isEntity = true;
protected $partialDescribeFields = null;
public function __construct($webserviceObject,$user,$adb,$log)
{
$this->meta = $this->getMetaInstance();
$this->tabId = $this->meta->getTabId();
}
public function VtigerModuleOperation($webserviceObject,$user,$adb,$log){
// PHP4-style constructor.
// This will NOT be invoked, unless a sub-class that extends `foo` calls it.
// In that case, call the new-style constructor to keep compatibility.
self::__construct($webserviceObject,$user,$adb,$log);
}
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
protected function getMetaInstance(){
if(empty(WebserviceEntityOperation::$metaCache[$this->webserviceObject->getEntityName()][$this->user->id])){
WebserviceEntityOperation::$metaCache[$this->webserviceObject->getEntityName()][$this->user->id] = new VtigerCRMObjectMeta($this->webserviceObject,$this->user);
}
return WebserviceEntityOperation::$metaCache[$this->webserviceObject->getEntityName()][$this->user->id];
}
public function create($elementType,$element){
$crmObject = new VtigerCRMObject($elementType, false);
$element = DataTransform::sanitizeForInsert($element,$this->meta);
$error = $crmObject->create($element);
if(!$error){
throw new WebServiceException(WebServiceErrorCode::$DATABASEQUERYERROR,
vtws_getWebserviceTranslatedString('LBL_'.
WebServiceErrorCode::$DATABASEQUERYERROR));
}
$id = $crmObject->getObjectId();
// Bulk Save Mode
if(CRMEntity::isBulkSaveMode()) {
// Avoiding complete read, as during bulk save mode, $result['id'] is enough
return array('id' => vtws_getId($this->meta->getEntityId(), $id) );
}
$error = $crmObject->read($id);
if(!$error){
throw new WebServiceException(WebServiceErrorCode::$DATABASEQUERYERROR,
vtws_getWebserviceTranslatedString('LBL_'.
WebServiceErrorCode::$DATABASEQUERYERROR));
}
return DataTransform::filterAndSanitize($crmObject->getFields(),$this->meta);
}
public function retrieve($id){
$ids = vtws_getIdComponents($id);
$elemid = $ids[1];
$crmObject = new VtigerCRMObject($this->tabId, true);
$error = $crmObject->read($elemid);
if(!$error){
throw new WebServiceException(WebServiceErrorCode::$DATABASEQUERYERROR,
vtws_getWebserviceTranslatedString('LBL_'.
WebServiceErrorCode::$DATABASEQUERYERROR));
}
return DataTransform::filterAndSanitize($crmObject->getFields(),$this->meta);
}
public function relatedIds($id, $relatedModule, $relatedLabel, $relatedHandler=null) {
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
$ids = vtws_getIdComponents($id);
$sourceModule = $this->webserviceObject->getEntityName();
global $currentModule;
$currentModule = $sourceModule;
$sourceRecordModel = Vtiger_Record_Model::getInstanceById($ids[1], $sourceModule);
$targetModel = Vtiger_RelationListView_Model::getInstance($sourceRecordModel, $relatedModule, $relatedLabel);
$sql = $targetModel->getRelationQuery();
$relatedWebserviceObject = VtigerWebserviceObject::fromName($adb,$relatedModule);
$relatedModuleWSId = $relatedWebserviceObject->getEntityId();
// Rewrite query to pull only crmid transformed as webservice id.
$sqlFromPart = substr($sql, stripos($sql, ' FROM ')+6);
$sql = sprintf("SELECT DISTINCT concat('%sx',vtiger_crmentity.crmid) as wsid FROM %s", $relatedModuleWSId, $sqlFromPart);
$rs = $this->pearDB->pquery($sql, array());
$relatedIds = array();
while ($row = $this->pearDB->fetch_array($rs)) {
$relatedIds[] = $row['wsid'];
}
return $relatedIds;
}
public function update($element){
$ids = vtws_getIdComponents($element["id"]);
$element = DataTransform::sanitizeForInsert($element,$this->meta);
$crmObject = new VtigerCRMObject($this->tabId, true);
$crmObject->setObjectId($ids[1]);
$error = $crmObject->update($element);
if(!$error){
throw new WebServiceException(WebServiceErrorCode::$DATABASEQUERYERROR,
vtws_getWebserviceTranslatedString('LBL_'.
WebServiceErrorCode::$DATABASEQUERYERROR));
}
$id = $crmObject->getObjectId();
$error = $crmObject->read($id);
if(!$error){
throw new WebServiceException(WebServiceErrorCode::$DATABASEQUERYERROR,
vtws_getWebserviceTranslatedString('LBL_'.
WebServiceErrorCode::$DATABASEQUERYERROR));
}
return DataTransform::filterAndSanitize($crmObject->getFields(),$this->meta);
}
public function revise($element){
$ids = vtws_getIdComponents($element["id"]);
$element = DataTransform::sanitizeForInsert($element,$this->meta);
$crmObject = new VtigerCRMObject($this->tabId, true);
$crmObject->setObjectId($ids[1]);
$error = $crmObject->revise($element);
if(!$error){
throw new WebServiceException(WebServiceErrorCode::$DATABASEQUERYERROR,
vtws_getWebserviceTranslatedString('LBL_'.
WebServiceErrorCode::$DATABASEQUERYERROR));
}
$id = $crmObject->getObjectId();
$error = $crmObject->read($id);
if(!$error){
throw new WebServiceException(WebServiceErrorCode::$DATABASEQUERYERROR,
vtws_getWebserviceTranslatedString('LBL_'.
WebServiceErrorCode::$DATABASEQUERYERROR));
}
return DataTransform::filterAndSanitize($crmObject->getFields(),$this->meta);
}
public function delete($id){
$ids = vtws_getIdComponents($id);
$elemid = $ids[1];
$crmObject = new VtigerCRMObject($this->tabId, true);
$error = $crmObject->delete($elemid);
if(!$error){
throw new WebServiceException(WebServiceErrorCode::$DATABASEQUERYERROR,
vtws_getWebserviceTranslatedString('LBL_'.
WebServiceErrorCode::$DATABASEQUERYERROR));
}
return array("status"=>"successful");
}
public function query($q){
$parser = new Parser($this->user, $q);
$error = $parser->parse();
if($error){
return $parser->getError();
}
$mysql_query = $parser->getSql();
$meta = $parser->getObjectMetaData();
$this->pearDB->startTransaction();
$result = $this->pearDB->pquery($mysql_query, array());
$tableIdColumn = $meta->getIdColumn();
$error = $this->pearDB->hasFailedTransaction();
$this->pearDB->completeTransaction();
if($error){
throw new WebServiceException(WebServiceErrorCode::$DATABASEQUERYERROR,
vtws_getWebserviceTranslatedString('LBL_'.
WebServiceErrorCode::$DATABASEQUERYERROR));
}
$noofrows = $this->pearDB->num_rows($result);
$output = array();
for($i=0; $i<$noofrows; $i++){
$row = $this->pearDB->fetchByAssoc($result,$i);
if(!isset($row[$tableIdColumn]) || !$meta->hasPermission(EntityMeta::$RETRIEVE,$row[$tableIdColumn])){
}
$output[$row[$tableIdColumn]] = DataTransform::sanitizeDataWithColumn($row,$meta);
if(php7_count($output)) {
//Added check if tags was requested or not
if(stripos($mysql_query, $meta->getEntityBaseTable().'.tags') !== false) $tags = Vtiger_Tag_Model::getAllAccessibleTags(array_keys($output));
foreach($output as $id => $row1) {
if(!empty($tags[$id])) $output[$id]['tags'] = $tags[$id];
$newOutput[] = $output[$id];
}
}
public function describe($elementType){
$app_strings = VTWS_PreserveGlobal::getGlobal('app_strings');
$current_user = vtws_preserveGlobal('current_user',$this->user);;
$label = (isset($app_strings[$elementType]))? $app_strings[$elementType]:$elementType;
$createable = (strcasecmp(isPermitted($elementType,EntityMeta::$CREATE),'yes')===0)? true:false;
$updateable = (strcasecmp(isPermitted($elementType,EntityMeta::$UPDATE),'yes')===0)? true:false;
$deleteable = $this->meta->hasDeleteAccess();
$retrieveable = $this->meta->hasReadAccess();
$fields = $this->getModuleFields();
Satish
committed
return array( 'label' => $label,
'name' => $elementType,
'createable' => $createable,
'updateable' => $updateable,
'deleteable' => $deleteable,
'retrieveable' => $retrieveable,
'fields' => $fields,
'idPrefix' => $this->meta->getEntityId(),
'isEntity' => $this->isEntity,
'allowDuplicates'=> $this->meta->isDuplicatesAllowed(),
'labelFields' => $this->meta->getNameFields());
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
}
public function describePartial($elementType, $fields=null) {
$this->partialDescribeFields = $fields;
$result = $this->describe($elementType);
$this->partialDescribeFields = null;
return $result;
}
function getModuleFields(){
$fields = array();
$moduleFields = $this->meta->getModuleFields();
foreach ($moduleFields as $fieldName=>$webserviceField) {
if(((int)$webserviceField->getPresence()) == 1) {
continue;
}
array_push($fields,$this->getDescribeFieldArray($webserviceField));
}
array_push($fields,$this->getIdField($this->meta->getObectIndexColumn()));
return $fields;
}
function getDescribeFieldArray($webserviceField){
$default_language = VTWS_PreserveGlobal::getGlobal('default_language');
$fieldLabel = getTranslatedString($webserviceField->getFieldLabelKey(), $this->meta->getTabName());
$typeDetails = array();
if (!is_array($this->partialDescribeFields)) {
$typeDetails = $this->getFieldTypeDetails($webserviceField);
} else if (in_array($webserviceField->getFieldName(), $this->partialDescribeFields)) {
$typeDetails = $this->getFieldTypeDetails($webserviceField);
}
//set type name, in the type details array.
$typeDetails['name'] = $webserviceField->getFieldDataType();
//Reference module List is missing in DescribePartial api response
if($typeDetails['name'] === "reference") {
$typeDetails['refersTo'] = $webserviceField->getReferenceList();
}
$editable = $this->isEditable($webserviceField);
Satish
committed
$describeArray = array( 'name' => $webserviceField->getFieldName(),
'label' => $fieldLabel,
'mandatory' => $webserviceField->isMandatory(),
'type' => $typeDetails,
'isunique' => $webserviceField->isUnique(),
'nullable' => $webserviceField->isNullable(),
'editable' => $editable);
if($webserviceField->hasDefault()){
$describeArray['default'] = $webserviceField->getDefault();
}
return $describeArray;
}
function getMeta(){
return $this->meta;
}
function getField($fieldName){
$moduleFields = $this->meta->getModuleFields();
return $this->getDescribeFieldArray($moduleFields[$fieldName]);
}
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
/**
* Function to get the file content
* @param type $id
* @return type
* @throws WebServiceException
*/
public function file_retrieve($crmid, $elementType, $attachmentId=false){
$ids = vtws_getIdComponents($crmid);
$crmid = $ids[1];
$recordModel = Vtiger_Record_Model::getInstanceById($crmid, $elementType);
if($attachmentId) {
$attachmentDetails = $recordModel->getFileDetails($attachmentId);
} else {
$attachmentDetails = $recordModel->getFileDetails();
}
$fileDetails = array();
if (!empty ($attachmentDetails)) {
if(is_array(current(($attachmentDetails)))) {
foreach ($attachmentDetails as $key => $attachment) {
$fileDetails[$key] = vtws_filedetails($attachment);
}
} else if(is_array($attachmentDetails)){
$fileDetails[] = vtws_filedetails($attachmentDetails);
}
}
return $fileDetails;
}