-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathdatamodel.combodo-email-synchro.xml
1294 lines (1241 loc) · 47.7 KB
/
datamodel.combodo-email-synchro.xml
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
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
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<itop_design xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.0">
<classes>
<class id="MailInboxBase" _delta="define">
<php_parent>
<name>_MailInboxBase</name>
</php_parent>
<parent>cmdbAbstractObject</parent>
<properties>
<comment>/**
* Default object for parametrization of the Ticket creation from eMails within
* the standard iTop user interface.
* Derive from this class to implement MailInboxes with a specific processing of
* the messages, and also a additional configuration options linked with this behavior.
*
* @package combodo-email-synchro
*/</comment>
<category>grant_by_profile,application</category>
<abstract>true</abstract>
<key_type>autoincrement</key_type>
<db_table>mailinbox_base</db_table>
<db_key_field>id</db_key_field>
<db_final_class_field>realclass</db_final_class_field>
<naming>
<format>%1$s</format>
<attributes>
<attribute id="login"/>
</attributes>
</naming>
<display_template/>
<icon>images/mailbox.png</icon>
<reconciliation>
<attributes>
<attribute id="server"/>
<attribute id="login"/>
<attribute id="protocol"/>
<attribute id="mailbox"/>
<attribute id="port"/>
</attributes>
</reconciliation>
</properties>
<fields>
<field id="server" xsi:type="AttributeString">
<sql>server</sql>
<default_value/>
<is_null_allowed>false</is_null_allowed>
</field>
<field id="mailbox" xsi:type="AttributeString">
<sql>mailbox</sql>
<default_value/>
<is_null_allowed>true</is_null_allowed>
</field>
<field id="login" xsi:type="AttributeString">
<sql>login</sql>
<default_value/>
<is_null_allowed>false</is_null_allowed>
</field>
<field id="password" xsi:type="AttributePassword">
<sql>password</sql>
<default_value/>
<is_null_allowed>true</is_null_allowed>
</field>
<field id="protocol" xsi:type="AttributeEnum">
<values>
<value>pop3</value>
<value>imap</value>
</values>
<sql>protocol</sql>
<default_value>imap</default_value>
<is_null_allowed>false</is_null_allowed>
</field>
<field id="port" xsi:type="AttributeInteger">
<sql>port</sql>
<default_value/>
<is_null_allowed>true</is_null_allowed>
</field>
<field id="active" xsi:type="AttributeEnum">
<values>
<value>yes</value>
<value>no</value>
</values>
<sql>active</sql>
<default_value>yes</default_value>
<is_null_allowed>false</is_null_allowed>
</field>
</fields>
<methods>
<method id="__construct">
<static>false</static>
<access>public</access>
<type>OQLMenuNode</type>
<code><![CDATA[ public function __construct($aRow = null, $sClassAlias = '', $aAttToLoad = null, $aExtendedDataSpec = null)
{
parent::__construct($aRow, $sClassAlias, $aAttToLoad, $aExtendedDataSpec);
$aData = CMDBSource::QueryToArray('SELECT @@global.max_allowed_packet');
$this->iMaxAttachmentSize = (int)$aData[0]['@@global.max_allowed_packet'] - 500; // Keep some room for the rest of the SQL query
$this->sBigFilesDir = MetaModel::GetModuleSetting('combodo-email-synchro', 'big_files_dir', '');
$this->sLastError = '';
}]]></code>
</method>
<method id="DisplayBareRelations">
<comment>/**
* Add an extra tab showing the content of the mailbox...
* @see cmdbAbstractObject::DisplayBareRelations()
*/</comment>
<static>false</static>
<access>public</access>
<type>Overload-cmdbAbstractObject</type>
<code><![CDATA[ function DisplayBareRelations(WebPage $oPage, $bEditMode = false)
{
parent::DisplayBareRelations($oPage, $bEditMode);
$bUseLegacy = static::UseLegacy();
if (!$bEditMode)
{
$oPage->SetCurrentTab(Dict::S('MailInbox:MailboxContent'));
$sCountQuery = "SELECT @@global.max_allowed_packet";
try
{
$iMaxAllowedPacket = CMDBSource::QueryToScalar($sCountQuery);
$iRecommended = MetaModel::GetModuleSetting('combodo-email-synchro', 'recommended_max_allowed_packet', 10*1024*1024);
if ($iMaxAllowedPacket < $iRecommended)
{
if ($iMaxAllowedPacket > 1024*1024)
{
$iMaxAllowedPacket = ($iMaxAllowedPacket / (1024*1024)).'M';
}
$iRecommended = ($iRecommended / (1024*1024)).'M';
$sMessage = Dict::Format('MailInbox:MaxAllowedPacketTooSmall', $iMaxAllowedPacket, $iRecommended);
$oPage->add('<div class="header_message message_error">'.$sMessage.'</div>');
}
}
catch (MySQLException $e)
{
}
$sForm = Dict::Format('MailInbox:Display_X_eMailsStartingFrom_Y', '<input type="text" size="3" id="mailbox_count" value="10"/>', '<input type="text" size="3" id="mailbox_start_index" value="0"/>');
$oPage->add('<p><form onsubmit="return false;">'.$sForm.' <button type="submit" id="mailbox_content_refresh" class="ibo-button ibo-is-neutral ibo-is-primary">'.Dict::S('UI:Button:Refresh').'</button></form></p>');
$oPage->add('<div id="mailbox_content_output"></div>');
$sAjaxUrl = addslashes(utils::GetAbsoluteUrlModulesRoot().basename(dirname(__FILE__)).'/ajax.php');
$iId = $this->GetKey();
$sConfirmMessage = Dict::S('MailInbox:MailboxContent:ConfirmMessage');
$sUseLegacy = $bUseLegacy === true ? 'true' : 'false';
$oPage->add_script(
<<<JS
function MailboxUpdateActionButtons()
{
if( $(".mailbox_item:checked").length > 0 )
{
$('.mailbox_button').prop('disabled', false);
}
else
{
$('.mailbox_button').prop('disabled', true);
}
}
function MailboxRefresh(data)
{
$('#mailbox_content_output').html(data);
$('#mailbox_content_refresh').prop('disabled', false);
if ($sUseLegacy){
$("#mailbox_content_output .listResults").tablesorter( { headers: { 0: {sorter: false}}, widgets: ['myZebra']} ); // sortable and zebra tables
}
$("#mailbox_checkall").click(function() {
var bChecked = $(this).prop('checked');
$(".mailbox_item").each(function() {
$(this).prop('checked', bChecked);
});
MailboxUpdateActionButtons();
});
$('.mailbox_button').prop('disabled', false);
$(".mailbox_item").bind('change', function() {
MailboxUpdateActionButtons();
});
$('#mailbox_reset_status').click(function() {
if (!window.confirm("$sConfirmMessage")) { return;}
MailboxResetStatus();
});
$('#mailbox_delete_messages').click(function() {
if (!window.confirm("$sConfirmMessage")) { return;}
MailboxDeleteMessages();
});
$('#mailbox_ignore_messages').click(function() {
if (!window.confirm("$sConfirmMessage")) { return;}
MailboxIgnoreMessages();
});
MailboxUpdateActionButtons();
}
function MailboxResetStatus()
{
var aUIDLs = [];
$(".mailbox_item:checked").each(function() {
aUIDLs.push(this.value);
});
$('#mailbox_content_output').html('<img src="../images/indicator.gif"/>');
$('#mailbox_content_refresh').prop('disabled', true);
var iStart = $('#mailbox_start_index').val();
var iCount = $('#mailbox_count').val();
$.post('$sAjaxUrl', {operation: 'mailbox_reset_status', id: $iId, start: iStart, count: iCount, aUIDLs: aUIDLs }, function(data) {
MailboxRefresh(data);
});
return false;
}
function MailboxDeleteMessages()
{
var aUIDLs = [];
$(".mailbox_item:checked").each(function() {
aUIDLs.push(this.value);
});
$('#mailbox_content_output').html('<img src="../images/indicator.gif"/>');
$('#mailbox_content_refresh').prop('disabled', true);
var iStart = $('#mailbox_start_index').val();
var iCount = $('#mailbox_count').val();
$.post('$sAjaxUrl', {operation: 'mailbox_delete_messages', id: $iId, start: iStart, count: iCount, aUIDLs: aUIDLs }, function(data) {
MailboxRefresh(data);
});
return false;
}
function MailboxIgnoreMessages()
{
var aUIDLs = [];
$(".mailbox_item:checked").each(function() {
aUIDLs.push(this.value);
});
$('#mailbox_content_output').html('<img src="../images/indicator.gif"/>');
$('#mailbox_content_refresh').prop('disabled', true);
var iStart = $('#mailbox_start_index').val();
var iCount = $('#mailbox_count').val();
$.post('$sAjaxUrl', {operation: 'mailbox_ignore_messages', id: $iId, start: iStart, count: iCount, aUIDLs: aUIDLs }, function(data) {
MailboxRefresh(data);
});
return false;
}
JS
);
$oPage->add_ready_script(
<<<JS
$('#mailbox_content_refresh').click(function() {
$('#mailbox_content_output').html('<img src="../images/indicator.gif"/>');
$('#mailbox_content_refresh').prop('disabled', true);
var iStart = $('#mailbox_start_index').val();
var iCount = $('#mailbox_count').val();
$.post('$sAjaxUrl', {operation: 'mailbox_content', id: $iId, start: iStart, count: iCount }, function(data) {
MailboxRefresh(data);
});
return false;
});
$('#mailbox_content_refresh').trigger('click');
JS
);
}
}]]></code>
</method>
<method id="DoCheckToWrite">
<comment>/**
* Overload the standard behavior to guarantee the unicity of either:
* login / server (pop3) or
* login / server / mailbox (imap)
* @see cmdbAbstractObject::DoCheckToWrite()
*/</comment>
<static>false</static>
<access>public</access>
<type>Overload-DBObject</type>
<code><![CDATA[ public function DoCheckToWrite()
{
parent::DoCheckToWrite();
// Note: This MUST be factorized later: declare unique keys (set of columns) in the data model
$aChanges = $this->ListChanges();
if (array_key_exists('login', $aChanges) || array_key_exists('server', $aChanges) || array_key_exists('mailbox', $aChanges) || array_key_exists('protocol', $aChanges))
{
$sNewLogin = $this->Get('login');
$sNewServer = $this->Get('server');
$sNewMailbox = $this->Get('mailbox');
if ($this->Get('protocol') == 'pop3')
{
// Ignore the mailbox
$sNewMailbox = '';
}
$oSearch = DBObjectSearch::FromOQL_AllData("SELECT MailInboxBase WHERE login = :newlogin AND server = :newserver AND ((protocol = 'imap' AND mailbox = :newmailbox) OR (protocol = 'pop3' AND '' = :newmailbox)) AND id != :id");
$oSet = new DBObjectSet($oSearch, array(), array('id' => $this->GetKey(), 'newlogin' => $sNewLogin, 'newserver' => $sNewServer, 'newmailbox' => $sNewMailbox));
if ($oSet->Count() > 0)
{
if ($this->Get('protocol') == 'pop3')
{
$this->m_aCheckIssues[] = Dict::Format('MailInbox:Login/ServerMustBeUnique', $sNewLogin, $sNewServer);
}
else
{
$this->m_aCheckIssues[] = Dict::Format('MailInbox:Login/Server/MailboxMustBeUnique', $sNewLogin, $sNewServer, $sNewMailbox);
}
}
}
} ]]></code>
</method>
<method id="SetNextAction">
<static>false</static>
<access>protected</access>
<type>Overload-DBObject</type>
<code><![CDATA[ protected function SetNextAction($iNextAction)
{
return $this->iNextAction = $iNextAction;
}]]></code>
</method>
<method id="GetNextAction">
<static>false</static>
<access>public</access>
<type>Overload-DBObject</type>
<code><![CDATA[ public function GetNextAction()
{
return $this->iNextAction;
}]]></code>
</method>
<method id="DispatchEmail">
<comment>/**
* Initial dispatching of an incoming email: determines what to do with the email
* @param EmailReplica $oEmailReplica The EmailReplica associated with the email. A new replica (i.e. not yet in DB) one for new emails
* @return int An action code from EmailProcessor
*/</comment>
<static>false</static>
<access>public</access>
<type>Overload-DBObject</type>
<code><![CDATA[ public function DispatchEmail(EmailReplica $oEmailReplica)
{
$this->SetNextAction(EmailProcessor::NO_ACTION);
if ($oEmailReplica->IsNew())
{
// New (unread) message, let's process it
$this->SetNextAction(EmailProcessor::PROCESS_MESSAGE);
}
else
{
$iTicketId = $oEmailReplica->Get('ticket_id');
$oTicket = MetaModel::GetObject('Ticket', $iTicketId, false /* => may not exist anymore */);
if (is_object($oTicket))
{
if ($oTicket->Get('status') == 'closed')
{
// The corresponding ticket was closed, delete the email (and the replica)
$this->SetNextAction(EmailProcessor::DELETE_MESSAGE);
}
}
else
{
// The corresponding ticket was deleted, delete the email (and the replica)
$this->SetNextAction(EmailProcessor::DELETE_MESSAGE);
}
}
return $this->GetNextAction();
}]]></code>
</method>
<method id="ProcessNewEmail">
<comment>/**
* Process an new (unread) incoming email
* @param EmailSource $oSource The source from which this email was read
* @param int $index The index of the message in the source
* @param EmailMessage $oEmail The decoded email
* @return Ticket The ticket created or updated in response to the email
*/</comment>
<static>false</static>
<access>public</access>
<type>Overload-DBObject</type>
<code><![CDATA[ public function ProcessNewEmail(EmailSource $oSource, $index, EmailMessage $oEmail)
{
$oTicket = null;
$this->SetNextAction(EmailProcessor::NO_ACTION);
$this->sLastError = null;
// Search if the caller email is an existing contact in iTop
$oCaller = $this->FindCaller($oEmail);
if ($oCaller === null)
{
// Cannot create/update a ticket if the caller is unknown
return null;
}
// Check whether we need to create a new ticket or to update an existing one
// First check if there are any iTop object mentioned in the headers of the eMail
$oTicket = $this->GetRelatedTicket($oEmail);
if ($this->bCreateOnly || !is_object($oTicket))
{
// No ticket associated with the incoming email, let's create a new ticket
$oTicket = $this->CreateTicketFromEmail($oEmail, $oCaller);
}
else
{
// Update the ticket with the incoming eMail
$this->UpdateTicketFromEmail($oTicket, $oEmail, $oCaller);
}
return $oTicket;
}]]></code>
</method>
<method id="FindCaller">
<comment>/**
* Search if the caller email is an existing contact in iTop
* @param EmailMessage $oEmail
* @return Contact | null
*/</comment>
<static>false</static>
<access>protected</access>
<type>Overload-DBObject</type>
<code><![CDATA[ protected function FindCaller(EmailMessage $oEmail)
{
$oCaller = null;
$sContactQuery = 'SELECT Person WHERE email = :email';
$oSet = new DBObjectSet(DBObjectSearch::FromOQL($sContactQuery), array(), array('email' => $oEmail->sCallerEmail));
$sAdditionalDescription = '';
switch($oSet->Count())
{
case 1:
// Ok, the caller was found in iTop
$oCaller = $oSet->Fetch();
break;
case 0:
// Here decide what to do ? Create a new user, assign the ticket to a 'fixed' Unknown Caller, reject the ticket...
// For now: let's do nothing, just ignore the ticket, it will be processed again later... in case the caller gets created
$this->Trace('No contact found for the email address ('.$oEmail->sCallerEmail.'), the email will not be processed');
$this->sLastError = 'No contact found for the email address ('.$oEmail->sCallerEmail.')';
break;
default:
$this->Trace('Found '.$oSet->Count().' callers with the same email address ('.$oEmail->sCallerEmail.'), the first one will be used...');
// Multiple callers with the same email address !!!
$sAdditionalDescription = "Warning:\nThere are ".$oSet->Count()." callers with the same email address (".$oEmail->sCallerEmail.") ";
$sAdditionalDescription = ".\nThe ticket was assigned to the first one found (at random).\n\n";
$oCaller = $oSet->Fetch();
}
return $oCaller;
}]]></code>
</method>
<method id="ReprocessOldEmail">
<comment>/**
* If DispatchMessage tells to reprocess an email, this method is called
* @param EmailSource $oSource The source from which this email was read
* @param int $index The index of the message in the source
* @param EmailMessage $oEmail The decoded email
* @param EmailReplica $oEmailReplica The replica associated with this email
* @return void
*/</comment>
<static>false</static>
<access>public</access>
<type>Overload-DBObject</type>
<code><![CDATA[ public function ReprocessOldEmail(EmailSource $oSource, $index, EmailMessage $oEmail, EmailReplica $oEmailReplica)
{
// Should not be called in this implementation, does nothing
$this->SetNextAction(EmailProcessor::NO_ACTION);
}]]></code>
</method>
<method id="GetRelatedTicket">
<comment><![CDATA[/**
* Get the iTop object related to this email, if any.
* The default implementation is based on the patterns in the headers
* 'in-reply-to' or 'references' automatically set in iTop notifications
* @param EmailMessage $oEmail
* @return DBObject | null
*/]]></comment>
<static>false</static>
<access>protected</access>
<type>Overload-DBObject</type>
<code><![CDATA[ protected function GetRelatedTicket(EmailMessage $oEmail)
{
$oTicket = $oEmail->oRelatedObject;
if (($oTicket != null) && !($oTicket instanceof Ticket))
{
$sObjClass = get_class($oTicket);
$sObjId = $oTicket->GetKey();
// The object referenced by the email is not a ticket !!
// => Forward the message and delete the ticket ??
$this->Trace("iTop Simple Email Synchro: WARNING the message ({$oEmail->sUIDL}) contains a reference to a valid iTop object that is NOT a ticket ! ({$sObjClass}::{$sObjId})");
$oTicket = null;
}
return $oTicket;
}]]></code>
</method>
<method id="CreateTicketFromEmail">
<comment><![CDATA[/**
* Actual creation of the ticket from the incoming email. Overload this method
* to implement your own behavior, if needed
* @param EmailMessage $oEmail The decoded incoming email
* @param Contact $oCaller The contact corresponding to the "From" email address
* @return Ticket the created ticket or null in case of failure
*/]]></comment>
<static>false</static>
<access>public</access>
<type>Overload-DBObject</type>
<code> public function CreateTicketFromEmail(EmailMessage $oEmail, Contact $oCaller)
{
$oTicket = null;
return $oTicket;
}</code>
</method>
<method id="UpdateTicketFromEmail">
<comment><![CDATA[/**
* Actual update of a ticket from the incoming email. Overload this method
* to implement your own behavior, if needed
* @param Ticket $oTicket The ticket to update
* @param EmailMessage $oEmail The decoded incoming email
* @param Contact $oCaller The contact corresponding to the "From" email address
* @return void
*/]]></comment>
<static>false</static>
<access>public</access>
<type>Overload-DBObject</type>
<code> public function UpdateTicketFromEmail(Ticket $oTicket, EmailMessage $oEmail, Contact $oCaller)
{
}</code>
</method>
<method id="HandleError">
<comment>/**
* Error handler... what to do in case of error ??
* @param EmailMessage $oEmail can be null in case of decoding error (like message too big)
* @param string $sErrorCode
* @param RawEmailMessage $oRawEmail In case decoding failed or null
* @param string $sAdditionalErrorMessage More information about the error (optional)
* @return int Next action: action code of the next action to execute
*/</comment>
<static>false</static>
<access>public</access>
<type>Overload-DBObject</type>
<code><![CDATA[ public function HandleError($oEmail, $sErrorCode, $oRawEmail = null, $sAdditionalErrorMessage = '')
{
$this->SetNextAction(EmailProcessor::NO_ACTION); // Ignore faulty emails
}]]></code>
</method>
<method id="AddAttachments">
<comment><![CDATA[/**
* Add the eMail's attachments to the given Ticket. Avoid duplicates (based on name/size/md5),
* avoid attaching blacklisted file types, and can potentially call an AntiVirus before adding the attachment
*
* @param Ticket $oTicket
* @param EmailMessage $oEmail
* @param bool $bNoDuplicates If true, don't add attachment that seem already attached to the ticket (same type, same name, same size, same md5 checksum)
* @param array $aIgnoredAttachments
* @param Contact $oCaller
* @param User $oUser
*
* @return array array of cid => attachment_id
* @throws \CoreException
* @throws \CoreUnexpectedValue
* @throws \CoreWarning
* @throws \Exception
* @throws \OQLException
*/]]></comment>
<static>false</static>
<access>protected</access>
<type>Overload-DBObject</type>
<code><![CDATA[ protected function AddAttachments(Ticket $oTicket, EmailMessage $oEmail, $bNoDuplicates = true, &$aIgnoredAttachments = array(), $oCaller = null, $oUser = null)
{
if (self::$iMinImageWidth === null)
{
$sMinImagesSize = MetaModel::GetModuleSetting('combodo-email-synchro', 'images_minimum_size','0x0');
if (preg_match('/^([0-9]+)x([0-9]+)$/i', $sMinImagesSize, $aMatches))
{
self::$iMinImageWidth = (int)$aMatches[1];
self::$iMinImageHeight = (int)$aMatches[2];
MailInboxesEmailProcessor::Trace("Info: minimum dimensions for attachment images: ".self::$iMinImageWidth."x".self::$iMinImageHeight." px. Images smaller than these dimensions will be ignored.");
}
else
{
MailInboxesEmailProcessor::Trace("Warning: incorrect format for the configuration value: 'images_minimum_size'. Expecting a value dddxddd (where ddd are digits), like 100x100, but got: '$sMinImagesSize'. No minimum value will be set.");
}
}
if (self::$iMaxImageWidth === null)
{
if (function_exists('imagecopyresampled'))
{
$sMaxImagesSize = MetaModel::GetModuleSetting('combodo-email-synchro', 'images_maximum_size', '');
if ($sMaxImagesSize != '')
{
if (preg_match('/^([0-9]+)x([0-9]+)$/i', $sMaxImagesSize, $aMatches))
{
self::$iMaxImageWidth = (int)$aMatches[1];
self::$iMaxImageHeight = (int)$aMatches[2];
MailInboxesEmailProcessor::Trace("Info: maximum dimensions for attachment images: ".self::$iMaxImageWidth."x".self::$iMaxImageHeight." px. Images bigger than these dimensions will be resized.");
}
else
{
MailInboxesEmailProcessor::Trace("Warning: incorrect format for the configuration value: 'images_maximum_size'. Expecting a value dddxddd (where ddd are digits), like 1000x1000, but got: '$sMaxImagesSize'. No maximum value will be set.");
self::$iMaxImageWidth = 0;
}
}
else
{
MailInboxesEmailProcessor::Trace("Info: no maximum dimensions configured for attachment images.");
self::$iMaxImageWidth = 0;
}
}
else
{
MailInboxesEmailProcessor::Trace("Info: GD not installed, cannot resize big images.");
self::$iMaxImageWidth = 0;
}
}
$aAddedAttachments = array();
// Process attachments (if any)
$aPreviousAttachments = array();
$aRejectedAttachments = array();
if ($bNoDuplicates)
{
$sOQL = "SELECT Attachment WHERE item_class = :class AND item_id = :id";
$oAttachments = new DBObjectSet(DBObjectSearch::FromOQL($sOQL), array(), array('class' => get_class($oTicket), 'id' => $oTicket->GetKey()));
while($oPrevAttachment = $oAttachments->Fetch())
{
$oDoc = $oPrevAttachment->Get('contents');
$data = $oDoc->GetData();
$aPreviousAttachments[] = array(
'class' => 'Attachment',
'filename' => $oDoc->GetFileName(),
'mimeType' => $oDoc->GetMimeType(),
'size' => strlen($data),
'md5' => md5($data),
'object' => $oPrevAttachment,
);
}
// same processing for InlineImages
if (class_exists('InlineImage'))
{
$sOQL = "SELECT InlineImage WHERE item_class = :class AND item_id = :id";
$oAttachments = new DBObjectSet(DBObjectSearch::FromOQL($sOQL), array(), array('class' => get_class($oTicket), 'id' => $oTicket->GetKey()));
while($oPrevAttachment = $oAttachments->Fetch())
{
$oDoc = $oPrevAttachment->Get('contents');
$data = $oDoc->GetData();
$aPreviousAttachments[] = array(
'class' => 'InlineImage',
'filename' => $oDoc->GetFileName(),
'mimeType' => $oDoc->GetMimeType(),
'size' => strlen($data),
'md5' => md5($data),
'object' => $oPrevAttachment,
);
}
}
}
foreach($oEmail->aAttachments as $aAttachment)
{
$bIgnoreAttachment =false;
// First check if the type is allowed as an attachment...
if (self::$aExcludeAttachments == null)
{
self::$aExcludeAttachments = MetaModel::GetModuleSetting('combodo-email-synchro', 'exclude_attachment_types', array());
}
if (!in_array($aAttachment['mimeType'], self::$aExcludeAttachments))
{
if ($this->IsImage($aAttachment['mimeType']))
{
$aImgInfo = array();
if (((self::$iMinImageWidth > 0) || (self::$iMaxImageWidth > 0)) && (($aImgInfo = $this->GetImageSize($aAttachment['content'], $aImgInfo)) !== false))
{
$iWidth = $aImgInfo[0];
$iHeight = $aImgInfo[1];
if (($iWidth < self::$iMinImageWidth) || ($iHeight < self::$iMinImageHeight))
{
$bIgnoreAttachment = true;
$aIgnoredAttachments[$aAttachment['content-id']] = true;
MailInboxesEmailProcessor::Trace("Info: attachment '{$aAttachment['filename']}': $iWidth x $iHeight px rejected because it is too small (probably a signature). The minimum size is configured to ".self::$iMinImageWidth." x ".self::$iMinImageHeight." px");
}
else if ((self::$iMaxImageWidth > 0) && (($iWidth > self::$iMaxImageWidth) || ($iHeight > self::$iMaxImageHeight)))
{
MailInboxesEmailProcessor::Trace("Info: attachment '{$aAttachment['filename']}': $iWidth x $iHeight px will be resized to fit into ".self::$iMaxImageWidth." x ".self::$iMaxImageHeight." px");
$aAttachment = self::ResizeImageToFit($aAttachment, $iWidth, $iHeight, self::$iMaxImageWidth, self::$iMaxImageHeight);
}
}
}
if (!$bIgnoreAttachment && $bNoDuplicates)
{
// Check if an attachment with the same name/type/size/md5 already exists
$iSize = strlen($aAttachment['content']);
if ($iSize > $this->iMaxAttachmentSize)
{
// The attachment is too big, reject it, and replace it by a text message, explaining what happened
MailInboxesEmailProcessor::Trace("Info: attachment '{$aAttachment['filename']}' too big (size = $iSize > max size = {$this->iMaxAttachmentSize} bytes)");
$aAttachment = $this->RejectBigAttachment($aAttachment, $oTicket);
$aRejectedAttachments[] = $aAttachment['content'];
}
else
{
$sMd5 = md5($aAttachment['content']);
foreach($aPreviousAttachments as $aPrevious)
{
if (($aAttachment['filename'] == $aPrevious['filename']) &&
($aAttachment['mimeType'] == $aPrevious['mimeType']) &&
($iSize == $aPrevious['size']) &&
($sMd5 == $aPrevious['md5']) )
{
// Skip this attachment
MailInboxesEmailProcessor::Trace("Info: attachment {$aAttachment['filename']} skipped, already attached to the ticket.");
$aAddedAttachments[$aAttachment['content-id']] = $aPrevious['object']; // Still remember it for processing inline images
$bIgnoreAttachment = true;
break;
}
}
}
}
if (!$bIgnoreAttachment && $this->ContainsViruses($aAttachment))
{
// Skip this attachment
MailInboxesEmailProcessor::Trace("Info: attachment {$aAttachment['filename']} is reported as containing a virus, skipped.");
$aRejectedAttachments[] = "attachment {$aAttachment['filename']} was reported as containing a virus, it has been skipped.";
$bIgnoreAttachment = true;
}
if (!$bIgnoreAttachment) {
if ($this->IsImage($aAttachment['mimeType']) && class_exists('InlineImage') && $aAttachment['inline']) {
$oAttachment = new InlineImage();
MailInboxesEmailProcessor::Trace("Info: email attachment {$aAttachment['filename']} will be stored as an InlineImage.");
$oAttachment->Set('secret', sprintf ('%06x', mt_rand(0, 0xFFFFFF))); // something not easy to guess
} else {
MailInboxesEmailProcessor::Trace("Info: email attachment {$aAttachment['filename']} will be stored as an Attachment.");
$oAttachment = new Attachment();
$oAttachment->SetIfNull('creation_date', time());
if ($oUser !== null) {
$oAttachment->Set('user_id', $oUser);
}
if (MetaModel::GetAttributeDef('Attachment', 'contact_id') instanceof \AttributeExternalKey && $oCaller !== null) {
$oAttachment->Set('contact_id', $oCaller);
}
}
if ($oTicket->IsNew()) {
$oAttachment->Set('item_class', get_class($oTicket));
} else {
$oAttachment->SetItem($oTicket);
}
$oBlob = new ormDocument($aAttachment['content'], $aAttachment['mimeType'], $aAttachment['filename']);
$oAttachment->Set('contents', $oBlob);
$oAttachment->DBInsert();
$oMyChangeOp = MetaModel::NewObject("CMDBChangeOpPlugin");
$oMyChange = CMDBObject::GetCurrentChange();
$oMyChangeOp->Set("change", $oMyChange->GetKey());
$oMyChangeOp->Set("objclass", get_class($oTicket));
$oMyChangeOp->Set("objkey", $oTicket->GetKey());
$oMyChangeOp->Set("description", Dict::Format('Attachments:History_File_Added', $aAttachment['filename']));
$iId = $oMyChangeOp->DBInsertNoReload();
MailInboxesEmailProcessor::Trace("Info: Attachment {$aAttachment['filename']} added to the ticket.");
$aAddedAttachments[$aAttachment['content-id']] = $oAttachment;
}
} else {
MailInboxesEmailProcessor::Trace("Info: The attachment {$aAttachment['filename']} was NOT added to the ticket because its type '{$aAttachment['mimeType']}' is excluded according to the configuration");
}
}
if (count($aRejectedAttachments) > 0)
{
// Report the problem to the administrator...
$this->HandleError($oEmail, 'rejected_attachments', null, implode("\n", $aRejectedAttachments));
}
return $aAddedAttachments;
}]]></code>
</method>
<method id="UpdateAttachments">
<comment><![CDATA[/**
*
* Update the item_class, item_id and item_org_id of the Attachments to match the values of the suplied ticket
* To be called if the attachments were created BEFORE the actual creation of the ticket in the database
* @param array $aAttachments An array of Attachment objects
* @param Ticket $oTicket
* @return an array of cid => Attachment
*/]]></comment>
<static>false</static>
<access>protected</access>
<type>Overload-DBObject</type>
<code><![CDATA[ protected function UpdateAttachments($aAttachments, Ticket $oTicket)
{
foreach($aAttachments as $oAttachment)
{
$oAttachment->SetItem($oTicket);
$oAttachment->DBUpdate();
}
}]]></code>
</method>
<method id="IsImage">
<comment>/**
* Check if an the given mimeType is an image that can be processed by the system
* @param string $sMimeType
* @return boolean
*/</comment>
<static>false</static>
<access>protected</access>
<type>Overload-DBObject</type>
<code><![CDATA[ protected function IsImage($sMimeType)
{
if (!function_exists('gd_info')) return false; // no image processing capability on this system
$bRet = false;
$aInfo = gd_info(); // What are the capabilities
switch($sMimeType)
{
case 'image/gif':
return $aInfo['GIF Read Support'];
break;
case 'image/jpeg':
return $aInfo['JPEG Support'];
break;
case 'image/png':
return $aInfo['PNG Support'];
break;
}
return $bRet;
}]]></code>
</method>
<method id="GetImageSize">
<static>false</static>
<access>protected</access>
<type>Overload-DBObject</type>
<code><![CDATA[ protected function GetImageSize($sImageData)
{
if (function_exists('getimagesizefromstring')) // PHP 5.4.0 or higher
{
$aRet = @getimagesizefromstring($sImageData);
}
else if(ini_get('allow_url_fopen'))
{
// work around to avoid creating a tmp file
$sUri = 'data://application/octet-stream;base64,'.base64_encode($sImageData);
$aRet = @getimagesize($sUri);
}
else
{
// Damned, need to create a tmp file
$sTempFile = tempnam(SetupUtils::GetTmpDir(), 'img-');
@file_put_contents($sTempFile, $sImageData);
$aRet = @getimagesize($sTempFile);
@unlink($sTempFile);
}
return $aRet;
}]]></code>
</method>
<method id="ContainsViruses">
<comment>/**
* Check if the supplied attachment contains a virus: implement you own methods based on your antivirus...
* The following (inactive) code is just provided as an example
* @param hash $aAttachment
* @return bool True if the attachment contains a virus (and should NOT be attached to the ticket), false otherwise
*/</comment>
<static>false</static>
<access>protected</access>
<type>Overload-DBObject</type>
<code><![CDATA[ protected function ContainsViruses($aAttachment)
{
// Not implemented, depends on your antivirus solution...
$bResult = false;
/*
// Below is an untested example of such a check, using Clam AntiVirus and the php-clamv extension
// (http://www.clamav.net/lang/en/ and http://php-clamav.sourceforge.net/)
if (function_exists('cl_scanfile'))
{
// Save the attachment to a temporary file
require_once(APPROOT.'setup/setuputils.class.inc.php');
$sTempFile = tempnam(SetupUtils::GetTmpDir(), 'clamav-');
@file_put_contents($sTempFile, $aAttachment['data']);
// Scan the file
$retcode = cl_scanfile($sTempFile, $sVirusName);
if ($retcode == CL_VIRUS)
{
MailInboxesEmailProcessor::Trace("Virus '$sVirusName' found in the attachment {$aAttachment['filename']}");
$bResult = true;
}
// Remove the temporary file
unlink($sTempFile);
}
*/
return $bResult;
}]]></code>
</method>
<method id="Trace">
<comment>/**
* Debug trace: activated/disabled by the configuration flag set for the base module...
* @param string $sText
*/</comment>
<static>false</static>
<access>public</access>
<type>Overload-DBObject</type>
<code> public function Trace($sText)
{
MailInboxesEmailProcessor::Trace($sText);
}</code>
</method>
<method id="FitTextIn">
<comment><![CDATA[/**
* Truncates the text, if needed, to fit into the given the maximum length and:
* 1) Takes care of replacing line endings by \r\n since the browser produces this kind of line endings inside a TEXTAREA
* 2) Trims the result to emulate the behavior of iTop's inputs
* @param string $sInputText
* @param int $iMaxLength
* @return string The fitted text
*/]]></comment>
<static>false</static>
<access>protected</access>
<type>Overload-DBObject</type>
<code><![CDATA[ protected function FitTextIn($sInputText, $iMaxLength)
{
$sInputText = trim($sInputText);
$sInputText = str_replace("\r\n", "\r", $sInputText);
$sInputText = str_replace("\n", "\r", $sInputText);
$sInputText = str_replace("\r", "\r\n", $sInputText);
if (mb_strlen($sInputText) > $iMaxLength)
{
$sInputText = trim(mb_substr($sInputText, 0, $iMaxLength-3)).'...';
}
return $sInputText;
}]]></code>
</method>
<method id="RejectBigAttachment">
<static>false</static>
<access>protected</access>
<type>Overload-DBObject</type>
<code><![CDATA[ protected function RejectBigAttachment($aAttachment, $oObj)
{
$sMessage = "The attachment {$aAttachment['filename']} (".strlen($aAttachment['content'])." bytes) is bigger than the maximum possible size ({$this->iMaxAttachmentSize}).\r\n";
if ($this->sBigFilesDir == '')
{
$sMessage .= "The attachment was deleted. In order to keep such attachments in the future, contact your administrator to:\r\n";
$sMessage .= "- either increase the 'max_allowed_packet' size in the configuration of the MySQL server to be able to store them in iTop\r\n";
$sMessage .= "- or configure the parameter 'big_files_dir' in the iTop configuration file, so that such attachments can be kept on the web server.\r\n";
}
else if (!is_writable($this->sBigFilesDir))
{
$sMessage .= "The attachment was deleted, since the directory where to save such files on the web server ({$this->sBigFilesDir}) is NOT writable to iTop.\r\n";
}
else
{
$sExtension = '.'.pathinfo($aAttachment['filename'], PATHINFO_EXTENSION);
$idx = 1;
$sFileName = 'attachment_'.(get_class($oObj)).'_'.($oObj->GetKey()).'_';
$hFile = false;
while(($hFile = fopen($this->sBigFilesDir.'/'.$sFileName.$idx.$sExtension, 'x')) === false)
{
$idx++;
}
fwrite($hFile, $aAttachment['content']);
fclose($hFile);
$sMessage .= "The attachment was saved as '{$sFileName}{$idx}{$sExtension}' on the web server in the directory '{$this->sBigFilesDir}'.\r\n";
$sMessage .= "In order to get such attachments into iTop, increase the 'max_allowed_packet' size in the configuration of the MySQL server.\r\n";
}
$aReplacement = array('content' => $sMessage, 'mimeType' => 'text/plain', 'filename' => 'warning.txt', 'content-id' => $aAttachment['content-id']);
return $aReplacement;
}]]></code>
</method>
<method id="InitObjectFromDefaultValues">
<comment><![CDATA[/**
* Initializes an object from default values
* Each default value must be a valid value for the given field
* @param DBObject $oObj The object to update
* @param hash $aValues The values to set attcode => value
*/]]></comment>
<static>false</static>
<access>protected</access>
<type>Overload-DBObject</type>
<code><![CDATA[ protected function InitObjectFromDefaultValues($oObj, $aValues)
{
foreach($aValues as $sAttCode => $value)
{
if (!MetaModel::IsValidAttCode(get_class($oObj), $sAttCode))
{
$this->Trace("Warning: cannot set default value '$value'; '$sAttCode' is not a valid attribute of the class ".get_class($oObj).".");
}
else
{
$oAttDef = MetaModel::GetAttributeDef(get_class($oObj), $sAttCode);
if (!$oAttDef->IsWritable())
{
$this->Trace("Warning: cannot set default value '$value' for the non-writable attribute: '$sAttCode'.");
}
else
{
$aArgs = array('this' => $oObj->ToArgs());
$aValues = $oAttDef->GetAllowedValues($aArgs);
if ($aValues == null)
{
// No special constraint for this attribute
if ($oAttDef->IsExternalKey())
{
$oTarget = MetaModel::GetObjectByName($oAttDef->GetTargetClass(), $value, false);