synchrodatasource.class.inc.php 110 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725
  1. <?php
  2. // Copyright (C) 2012 Combodo SARL
  3. //
  4. // This program is free software; you can redistribute it and/or modify
  5. // it under the terms of the GNU General Public License as published by
  6. // the Free Software Foundation; version 3 of the License.
  7. //
  8. // This program is distributed in the hope that it will be useful,
  9. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. // GNU General Public License for more details.
  12. //
  13. // You should have received a copy of the GNU General Public License
  14. // along with this program; if not, write to the Free Software
  15. // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16. /**
  17. * Data Exchange - synchronization with external applications (incoming data)
  18. *
  19. * @author Erwan Taloc <erwan.taloc@combodo.com>
  20. * @author Romain Quetiez <romain.quetiez@combodo.com>
  21. * @author Denis Flaven <denis.flaven@combodo.com>
  22. * @license http://www.opensource.org/licenses/gpl-3.0.html LGPL
  23. */
  24. class SynchroExceptionNotStarted extends CoreException
  25. {
  26. }
  27. class SynchroDataSource extends cmdbAbstractObject
  28. {
  29. public static function Init()
  30. {
  31. $aParams = array
  32. (
  33. "category" => "core/cmdb,view_in_gui",
  34. "key_type" => "autoincrement",
  35. "name_attcode" => array('name'),
  36. "state_attcode" => "",
  37. "reconc_keys" => array(),
  38. "db_table" => "priv_sync_datasource",
  39. "db_key_field" => "id",
  40. "db_finalclass_field" => "realclass",
  41. "display_template" => "",
  42. "icon" => "../images/synchro.png",
  43. );
  44. MetaModel::Init_Params($aParams);
  45. //MetaModel::Init_InheritAttributes();
  46. MetaModel::Init_AddAttribute(new AttributeString("name", array("allowed_values"=>null, "sql"=>"name", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
  47. MetaModel::Init_AddAttribute(new AttributeString("description", array("allowed_values"=>null, "sql"=>"description", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
  48. MetaModel::Init_AddAttribute(new AttributeEnum("status", array("allowed_values"=>new ValueSetEnum('implementation,production,obsolete'), "sql"=>"status", "default_value"=>"implementation", "is_null_allowed"=>false, "depends_on"=>array())));
  49. MetaModel::Init_AddAttribute(new AttributeExternalKey("user_id", array("targetclass"=>"User", "jointype"=>null, "allowed_values"=>null, "sql"=>"user_id", "is_null_allowed"=>true, "on_target_delete"=>DEL_MANUAL, "depends_on"=>array())));
  50. MetaModel::Init_AddAttribute(new AttributeExternalKey("notify_contact_id", array("targetclass"=>"Contact", "jointype"=>null, "allowed_values"=>null, "sql"=>"notify_contact_id", "is_null_allowed"=>true, "on_target_delete"=>DEL_MANUAL, "depends_on"=>array())));
  51. MetaModel::Init_AddAttribute(new AttributeClass("scope_class", array("class_category"=>"bizmodel,addon/authentication", "more_values"=>"", "sql"=>"scope_class", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
  52. // Declared here for a future usage, but ignored so far
  53. MetaModel::Init_AddAttribute(new AttributeString("scope_restriction", array("allowed_values"=>null, "sql"=>"scope_restriction", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
  54. //MetaModel::Init_AddAttribute(new AttributeDateTime("last_synchro_date", array("allowed_values"=>null, "sql"=>"last_synchro_date", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
  55. // Format: seconds (int)
  56. MetaModel::Init_AddAttribute(new AttributeDuration("full_load_periodicity", array("allowed_values"=>null, "sql"=>"full_load_periodicity", "default_value"=>86400, "is_null_allowed"=>true, "depends_on"=>array())));
  57. // MetaModel::Init_AddAttribute(new AttributeString("reconciliation_list", array("allowed_values"=>null, "sql"=>"reconciliation_list", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
  58. MetaModel::Init_AddAttribute(new AttributeEnum("reconciliation_policy", array("allowed_values"=>new ValueSetEnum('use_primary_key,use_attributes'), "sql"=>"reconciliation_policy", "default_value"=>"use_attributes", "is_null_allowed"=>false, "depends_on"=>array())));
  59. MetaModel::Init_AddAttribute(new AttributeEnum("action_on_zero", array("allowed_values"=>new ValueSetEnum('create,error'), "sql"=>"action_on_zero", "default_value"=>"create", "is_null_allowed"=>false, "depends_on"=>array())));
  60. MetaModel::Init_AddAttribute(new AttributeEnum("action_on_one", array("allowed_values"=>new ValueSetEnum('update,error'), "sql"=>"action_on_one", "default_value"=>"update", "is_null_allowed"=>false, "depends_on"=>array())));
  61. MetaModel::Init_AddAttribute(new AttributeEnum("action_on_multiple", array("allowed_values"=>new ValueSetEnum('take_first,create,error'), "sql"=>"action_on_multiple", "default_value"=>"error", "is_null_allowed"=>false, "depends_on"=>array())));
  62. MetaModel::Init_AddAttribute(new AttributeEnum("delete_policy", array("allowed_values"=>new ValueSetEnum('ignore,delete,update,update_then_delete'), "sql"=>"delete_policy", "default_value"=>"ignore", "is_null_allowed"=>false, "depends_on"=>array())));
  63. MetaModel::Init_AddAttribute(new AttributeString("delete_policy_update", array("allowed_values"=>null, "sql"=>"delete_policy_update", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
  64. // Format: seconds (unsigned int)
  65. MetaModel::Init_AddAttribute(new AttributeDuration("delete_policy_retention", array("allowed_values"=>null, "sql"=>"delete_policy_retention", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
  66. MetaModel::Init_AddAttribute(new AttributeLinkedSet("attribute_list", array("linked_class"=>"SynchroAttribute", "ext_key_to_me"=>"sync_source_id", "allowed_values"=>null, "count_min"=>0, "count_max"=>0, "depends_on"=>array())));
  67. // Not used yet !
  68. MetaModel::Init_AddAttribute(new AttributeEnum("user_delete_policy", array("allowed_values"=>new ValueSetEnum('everybody,administrators,nobody'), "sql"=>"user_delete_policy", "default_value"=>"nobody", "is_null_allowed"=>true, "depends_on"=>array())));
  69. MetaModel::Init_AddAttribute(new AttributeURL("url_icon", array("allowed_values"=>null, "sql"=>"url_icon", "default_value"=>null, "is_null_allowed"=>true, "target"=> '_top', "depends_on"=>array())));
  70. // The field below is not a real URL since it can contain placeholders like $replica->primary_key$ which are not syntactically allowed in a real URL
  71. MetaModel::Init_AddAttribute(new AttributeString("url_application", array("allowed_values"=>null, "sql"=>"url_application", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
  72. // Display lists
  73. MetaModel::Init_SetZListItems('details', array(
  74. 'col:0'=> array(
  75. 'fieldset:SynchroDataSource:Description' => array('name','description','status','scope_class','user_id','notify_contact_id','url_icon','url_application')),
  76. 'col:1'=> array(
  77. 'fieldset:SynchroDataSource:Reconciliation' => array('reconciliation_policy','action_on_zero','action_on_one','action_on_multiple'),
  78. 'fieldset:SynchroDataSource:Deletion' => array('user_delete_policy','full_load_periodicity','delete_policy','delete_policy_update','delete_policy_retention'))
  79. )
  80. );
  81. MetaModel::Init_SetZListItems('list', array('scope_class', 'status', 'user_id', 'full_load_periodicity')); // Attributes to be displayed for a list
  82. // Search criteria
  83. MetaModel::Init_SetZListItems('standard_search', array('name', 'status', 'scope_class', 'user_id')); // Criteria of the std search form
  84. // MetaModel::Init_SetZListItems('advanced_search', array('name')); // Criteria of the advanced search form
  85. }
  86. public function DisplayBareRelations(WebPage $oPage, $bEditMode = false)
  87. {
  88. if (!$this->IsNew())
  89. {
  90. $oPage->SetCurrentTab(Dict::S('Core:SynchroAttributes'));
  91. $oAttributeSet = $this->Get('attribute_list');
  92. $aAttributes = array();
  93. while($oAttribute = $oAttributeSet->Fetch())
  94. {
  95. $aAttributes[$oAttribute->Get('attcode')] = $oAttribute;
  96. }
  97. // Columns of the form
  98. $aAttribs = array();
  99. foreach(array('attcode', 'reconciliation', 'update', 'update_policy', 'reconciliation_attcode') as $s )
  100. {
  101. $aAttribs[$s] = array( 'label' => Dict::S("Core:SynchroAtt:$s"), "description" => Dict::S("Core:SynchroAtt:$s+"));
  102. }
  103. // Rows of the form
  104. $aValues = array();
  105. foreach(MetaModel::ListAttributeDefs($this->GetTargetClass()) as $sAttCode=>$oAttDef)
  106. {
  107. if ($oAttDef->IsWritable())
  108. {
  109. if (isset($aAttributes[$sAttCode]))
  110. {
  111. $oAttribute = $aAttributes[$sAttCode];
  112. }
  113. else
  114. {
  115. if ($oAttDef->IsExternalKey())
  116. {
  117. $oAttribute = new SynchroAttExtKey();
  118. $oAttribute->Set('reconciliation_attcode', ''); // Blank means by pkey
  119. }
  120. elseif ($oAttDef->IsLinkSet() && $oAttDef->IsIndirect())
  121. {
  122. $oAttribute = new SynchroAttLinkSet();
  123. // Todo - add these settings into the form
  124. $oAttribute->Set('row_separator', MetaModel::GetConfig()->Get('link_set_item_separator'));
  125. $oAttribute->Set('attribute_separator', MetaModel::GetConfig()->Get('link_set_attribute_separator'));
  126. $oAttribute->Set('value_separator', MetaModel::GetConfig()->Get('link_set_value_separator'));
  127. $oAttribute->Set('attribute_qualifier', MetaModel::GetConfig()->Get('link_set_attribute_qualifier'));
  128. }
  129. elseif ($oAttDef->IsScalar())
  130. {
  131. $oAttribute = new SynchroAttribute();
  132. }
  133. else
  134. {
  135. $oAttribute = null;
  136. }
  137. if (!is_null($oAttribute))
  138. {
  139. $oAttribute->Set('sync_source_id', $this->GetKey());
  140. $oAttribute->Set('attcode', $sAttCode);
  141. $oAttribute->Set('reconcile', MetaModel::IsReconcKey($this->GetTargetClass(), $sAttCode) ? 1 : 0);
  142. $oAttribute->Set('update', 1);
  143. $oAttribute->Set('update_policy', 'master_locked');
  144. }
  145. }
  146. if (!is_null($oAttribute))
  147. {
  148. if (!$bEditMode)
  149. {
  150. // Read-only mode
  151. $aRow['reconciliation'] = $oAttribute->Get('reconcile') == 1 ? Dict::S('Core:SynchroReconcile:Yes') : Dict::S('Core:SynchroReconcile:No');
  152. $aRow['update'] = $oAttribute->Get('update') == 1 ? Dict::S('Core:SynchroUpdate:Yes') : Dict::S('Core:SynchroUpdate:No');
  153. $aRow['attcode'] = MetaModel::GetLabel($this->GetTargetClass(), $oAttribute->Get('attcode'));
  154. $aRow['update_policy'] = $oAttribute->GetAsHTML('update_policy');
  155. if ($oAttDef->IsExternalKey())
  156. {
  157. $aRow['reconciliation_attcode'] = $oAttribute->GetAsHTML('reconciliation_attcode');
  158. }
  159. else
  160. {
  161. $aRow['reconciliation_attcode'] = '&nbsp;';
  162. }
  163. }
  164. else
  165. {
  166. // Edit mode
  167. $sAttCode = $oAttribute->Get('attcode');
  168. $sChecked = $oAttribute->Get('reconcile') == 1 ? 'checked' : '';
  169. $aRow['reconciliation'] = "<input type=\"checkbox\" name=\"reconciliation[$sAttCode]\" $sChecked/>";
  170. $sChecked = $oAttribute->Get('update') == 1 ? 'checked' : '';
  171. $aRow['update'] = "<input type=\"checkbox\" name=\"update[$sAttCode]\" $sChecked/>";
  172. $aRow['attcode'] = MetaModel::GetLabel($this->GetTargetClass(), $oAttribute->Get('attcode'));
  173. $oUpdateAttDef = MetaModel::GetAttributeDef(get_class($oAttribute), 'update_policy');
  174. $aRow['update_policy'] = cmdbAbstractObject::GetFormElementForField($oPage, get_class($oAttribute), 'update_policy', $oUpdateAttDef, $oAttribute->Get('update_policy'), '', 'update_policy_'.$sAttCode, "[$sAttCode]");
  175. if ($oAttDef->IsExternalKey())
  176. {
  177. $aRow['reconciliation_attcode'] = $oAttribute->GetReconciliationFormElement($oAttDef->GetTargetClass(), "attr_reconciliation_attcode[$sAttCode]");
  178. }
  179. else
  180. {
  181. $aRow['reconciliation_attcode'] = '&nbsp;';
  182. }
  183. }
  184. $aValues[] = $aRow;
  185. }
  186. }
  187. }
  188. $oPage->p(Dict::Format('Class:SynchroDataSource:DataTable', $this->GetDataTable()));
  189. $oPage->Table($aAttribs, $aValues);
  190. $this->DisplayStatusTab($oPage);
  191. }
  192. parent::DisplayBareRelations($oPage, $bEditMode);
  193. }
  194. /**
  195. * Displays the status (SynchroLog) of the datasource in a graphical manner
  196. * @param $oPage WebPage
  197. * @return void
  198. */
  199. protected function DisplayStatusTab(WebPage $oPage)
  200. {
  201. $oPage->SetCurrentTab(Dict::S('Core:SynchroStatus'));
  202. $sSelectSynchroLog = 'SELECT SynchroLog WHERE sync_source_id = :source_id';
  203. $oSetSynchroLog = new CMDBObjectSet(DBObjectSearch::FromOQL($sSelectSynchroLog), array('start_date' => false) /* order by*/, array('source_id' => $this->GetKey()));
  204. if ($oSetSynchroLog->Count() > 0)
  205. {
  206. $oLastLog = $oSetSynchroLog->Fetch();
  207. $sStartDate = $oLastLog->Get('start_date');
  208. $oLastLog->Get('stats_nb_replica_seen');
  209. $iLastLog = 0;
  210. $iDSid = $this->GetKey();
  211. if ($oLastLog->Get('status') == 'running')
  212. {
  213. // Still running !
  214. $oPage->p('<h2>'.Dict::Format('Core:Synchro:SynchroRunningStartedOn_Date', $sStartDate).'</h2>');
  215. }
  216. else
  217. {
  218. $sEndDate = $oLastLog->Get('end_date');
  219. $iLastLog = $oLastLog->GetKey();
  220. $oPage->p('<h2>'.Dict::Format('Core:Synchro:SynchroEndedOn_Date', $sEndDate).'</h2>');
  221. $sOQL = "SELECT SynchroReplica WHERE sync_source_id=$iDSid";
  222. $oSet = new DBObjectSet(DBObjectSearch::FromOQL($sOQL));
  223. $iCountAllReplicas = $oSet->Count();
  224. $sAllReplicas = "<a href=\"../synchro/replica.php?operation=oql&datasource=$iDSid&oql=$sOQL\">$iCountAllReplicas</a>";
  225. $sOQL = "SELECT SynchroReplica WHERE sync_source_id=$iDSid AND status_last_error !=''";
  226. $oSet = new DBObjectSet(DBObjectSearch::FromOQL($sOQL));
  227. $iCountAllErrors = $oSet->Count();
  228. $sAllErrors = "<a href=\"../synchro/replica.php?operation=oql&datasource=$iDSid&oql=$sOQL\">$iCountAllErrors</a>";
  229. $sOQL = "SELECT SynchroReplica WHERE sync_source_id=$iDSid AND status_last_warning !=''";
  230. $oSet = new DBObjectSet(DBObjectSearch::FromOQL($sOQL));
  231. $iCountAllWarnings = $oSet->Count();
  232. $sAllWarnings = "<a href=\"../synchro/replica.php?operation=oql&datasource=$iDSid&oql=$sOQL\">$iCountAllWarnings</a>";
  233. $oPage->p('<h2>'.Dict::Format('Core:Synchro:ListReplicas_AllReplicas_Errors_Warnings', $sAllReplicas, $sAllErrors, $sAllWarnings).'</h2>');
  234. }
  235. $oPage->add('<table class="synoptics"><tr><td style="color:#333;vertical-align:top">');
  236. // List all the log entries for the user to select
  237. $oPage->add('<h2 style="line-height:55px;">'.Dict::S('Core:Synchro:History').'</h2>');
  238. $oSetSynchroLog->Rewind();
  239. $oPage->add('<select size="25" onChange="UpdateSynoptics(this.value);">');
  240. $sSelected = ' selected'; // First log is selected by default
  241. $sScript = "var aSynchroLog = {\n";
  242. while($oLog = $oSetSynchroLog->Fetch())
  243. {
  244. $sLogTitle = Dict::Format('Core:SynchroLogTitle', $oLog->Get('status'), $oLog->Get('start_date'));
  245. $oPage->add('<option value="'.$oLog->GetKey().'"'.$sSelected.'>'.$sLogTitle.'</option>');
  246. $sSelected = ''; // only the first log is selected by default
  247. $aData = $this->ProcessLog($oLog);
  248. $sScript .= '"'.$oLog->GetKey().'": '.json_encode($aData).",\n";
  249. }
  250. $sScript .= "end: 'Done'";
  251. $sScript .= "};\n";
  252. $sScript .= <<<EOF
  253. var sLastLog = '$iLastLog';
  254. function ToggleSynoptics(sId, bShow)
  255. {
  256. if (bShow)
  257. {
  258. $(sId).show();
  259. }
  260. else
  261. {
  262. $(sId).hide();
  263. }
  264. }
  265. function UpdateSynoptics(id)
  266. {
  267. var aValues = aSynchroLog[id];
  268. if (aValues == undefined) return;
  269. for (var sKey in aValues)
  270. {
  271. $('#c_'+sKey).html(aValues[sKey]);
  272. var fOpacity = (aValues[sKey] == 0) ? 0.3 : 1;
  273. $('#'+sKey).fadeTo("slow", fOpacity);
  274. }
  275. //alert('id = '+id+', lastLog='+sLastLog+', id==sLastLog: '+(id==sLastLog)+' obj_updated_errors: '+aValues['obj_updated_errors']);
  276. if ( (id == sLastLog) && (aValues['obj_new_errors'] > 0) )
  277. {
  278. $('#new_errors_link').show();
  279. }
  280. else
  281. {
  282. $('#new_errors_link').hide();
  283. }
  284. if ( (id == sLastLog) && (aValues['obj_updated_errors'] > 0) )
  285. {
  286. $('#updated_errors_link').show();
  287. }
  288. else
  289. {
  290. $('#updated_errors_link').hide();
  291. }
  292. if ( (id == sLastLog) && (aValues['obj_disappeared_errors'] > 0) )
  293. {
  294. $('#disappeared_errors_link').show();
  295. }
  296. else
  297. {
  298. $('#disappeared_errors_link').hide();
  299. }
  300. ToggleSynoptics('#cw_obj_created_warnings', aValues['obj_created_warnings'] > 0);
  301. ToggleSynoptics('#cw_obj_new_updated_warnings', aValues['obj_new_updated_warnings'] > 0);
  302. ToggleSynoptics('#cw_obj_new_unchanged_warnings', aValues['obj_new_unchanged_warnings'] > 0);
  303. ToggleSynoptics('#cw_obj_updated_warnings', aValues['obj_updated_warnings'] > 0);
  304. ToggleSynoptics('#cw_obj_unchanged_warnings', aValues['obj_unchanged_warnings'] > 0);
  305. }
  306. EOF
  307. ;
  308. $oPage->add_script($sScript);
  309. $oPage->add('</select>');
  310. $oPage->add('</td><td style="vertical-align:top;">');
  311. // Now build the big "synoptics" view
  312. $aData = $this->ProcessLog($oLastLog);
  313. $sNbReplica = $this->GetIcon()."&nbsp;".Dict::Format('Core:Synchro:Nb_Replica', "<span id=\"c_nb_replica_total\">{$aData['nb_replica_total']}</span>");
  314. $sNbObjects = MetaModel::GetClassIcon($this->GetTargetClass())."&nbsp;".Dict::Format('Core:Synchro:Nb_Class:Objects', $this->GetTargetClass(), "<span id=\"c_nb_obj_total\">{$aData['nb_obj_total']}</span>");
  315. $oPage->add(
  316. <<<EOF
  317. <table class="synoptics">
  318. <tr class="synoptics_header">
  319. <td>$sNbReplica</td><td>&nbsp;</td><td>$sNbObjects</td>
  320. </tr>
  321. <tr>
  322. EOF
  323. );
  324. $sBaseOQL = "SELECT SynchroReplica WHERE sync_source_id=".$this->GetKey()." AND status_last_error!=''";
  325. $oPage->add($this->HtmlBox('repl_ignored', $aData, '#999').'<td colspan="2">&nbsp;</td>');
  326. $oPage->add("</tr>\n<tr>");
  327. $oPage->add($this->HtmlBox('repl_disappeared', $aData, '#630', 'rowspan="4"').'<td rowspan="4" class="arrow">=&gt;</td>'.$this->HtmlBox('obj_disappeared_no_action', $aData, '#333'));
  328. $oPage->add("</tr>\n<tr>");
  329. $oPage->add($this->HtmlBox('obj_deleted', $aData, '#000'));
  330. $oPage->add("</tr>\n<tr>");
  331. $oPage->add($this->HtmlBox('obj_obsoleted', $aData, '#630'));
  332. $oPage->add("</tr>\n<tr>");
  333. $sOQL = urlencode($sBaseOQL." AND status='obsolete'");
  334. $oPage->add($this->HtmlBox('obj_disappeared_errors', $aData, '#C00', '', " <a style=\"color:#fff\" href=\"../synchro/replica.php?operation=oql&datasource=$iDSid&oql=$sOQL\" id=\"disappeared_errors_link\">Show</a>"));
  335. $oPage->add("</tr>\n<tr>");
  336. $oPage->add($this->HtmlBox('repl_existing', $aData, '#093', 'rowspan="3"').'<td rowspan="3" class="arrow">=&gt;</td>'.$this->HtmlBox('obj_unchanged', $aData, '#393'));
  337. $oPage->add("</tr>\n<tr>");
  338. $oPage->add($this->HtmlBox('obj_updated', $aData, '#3C3'));
  339. $oPage->add("</tr>\n<tr>");
  340. $sOQL = urlencode($sBaseOQL." AND status='modified'");
  341. $oPage->add($this->HtmlBox('obj_updated_errors', $aData, '#C00', '', " <a style=\"color:#fff\" href=\"../synchro/replica.php?operation=oql&datasource=$iDSid&oql=$sOQL\" id=\"updated_errors_link\">Show</a>"));
  342. $oPage->add("</tr>\n<tr>");
  343. $oPage->add($this->HtmlBox('repl_new', $aData, '#339', 'rowspan="4"').'<td rowspan="4" class="arrow">=&gt;</td>'.$this->HtmlBox('obj_new_unchanged', $aData, '#393'));
  344. $oPage->add("</tr>\n<tr>");
  345. $oPage->add($this->HtmlBox('obj_new_updated', $aData, '#3C3'));
  346. $oPage->add("</tr>\n<tr>");
  347. $oPage->add($this->HtmlBox('obj_created', $aData, '#339'));
  348. $oPage->add("</tr>\n<tr>");
  349. $sOQL = urlencode($sBaseOQL." AND status='new'");
  350. $oPage->add($this->HtmlBox('obj_new_errors', $aData, '#C00', '', " <a style=\"color:#fff\" href=\"../synchro/replica.php?operation=oql&datasource=$iDSid&oql=$sOQL\" id=\"new_errors_link\">Show</a>"));
  351. $oPage->add("</tr>\n</table>\n");
  352. $oPage->add('</td></tr></table>');
  353. $oPage->add_ready_script("UpdateSynoptics('$iLastLog')");
  354. }
  355. else
  356. {
  357. $oPage->p('<h2>'.Dict::S('Core:Synchro:NeverRun').'</h2>');
  358. }
  359. }
  360. protected function HtmlBox($sId, $aData, $sColor, $sHTMLAttribs = '', $sErrorLink = '')
  361. {
  362. $iCount = $aData[$sId];
  363. $sCount = "<span id=\"c_{$sId}\">$iCount</span>";
  364. $sLabel = Dict::Format('Core:Synchro:label_'.$sId, $sCount);
  365. $sOpacity = ($iCount==0) ? "opacity:0.3;" : "";
  366. if (isset($aData[$sId.'_warnings']))
  367. {
  368. $sLabel .= " <span id=\"cw_{$sId}_warnings\"><img src=\"../images/error.png\" style=\"vertical-align:middle\"/> (<span id=\"c_{$sId}_warnings\">".$aData[$sId.'_warnings']."</span>)</span>";
  369. }
  370. return "<td id=\"$sId\" style=\"background-color:$sColor;$sOpacity;\" {$sHTMLAttribs}>{$sLabel}{$sErrorLink}</td>";
  371. }
  372. protected function ProcessLog($oLastLog)
  373. {
  374. $aData = array(
  375. 'obj_deleted' => $oLastLog->Get('stats_nb_obj_deleted'),
  376. 'obj_obsoleted' => $oLastLog->Get('stats_nb_obj_obsoleted'),
  377. 'obj_disappeared_errors' => $oLastLog->Get('stats_nb_obj_obsoleted_errors') + $oLastLog->Get('stats_nb_obj_deleted_errors'),
  378. 'obj_disappeared_no_action' => $oLastLog->Get('stats_nb_replica_disappeared_no_action'),
  379. 'obj_updated' => $oLastLog->Get('stats_nb_obj_updated'),
  380. 'obj_updated_warnings' => $oLastLog->Get('stats_nb_obj_updated_warnings'),
  381. 'obj_updated_errors' => $oLastLog->Get('stats_nb_obj_updated_errors'),
  382. 'obj_new_updated' => $oLastLog->Get('stats_nb_obj_new_updated'),
  383. 'obj_new_updated_warnings' => $oLastLog->Get('stats_nb_obj_new_updated_warnings'),
  384. 'obj_new_unchanged' => $oLastLog->Get('stats_nb_obj_new_unchanged'),
  385. 'obj_created' => $oLastLog->Get('stats_nb_obj_created'),
  386. 'obj_created_warnings' => $oLastLog->Get('stats_nb_obj_created_warnings'),
  387. 'obj_created_errors' => $oLastLog->Get('stats_nb_obj_created_errors'),
  388. 'obj_unchanged_warnings' => $oLastLog->Get('stats_nb_obj_unchanged_warnings'),
  389. );
  390. $iReconciledErrors = $oLastLog->Get('stats_nb_replica_reconciled_errors');
  391. $iDisappeared = $aData['obj_disappeared_errors'] + $aData['obj_obsoleted'] + $aData['obj_deleted'] + $aData['obj_disappeared_no_action'];
  392. $aData['repl_disappeared'] = $iDisappeared;
  393. $iNewErrors = $aData['obj_created_errors'] + $oLastLog->Get('stats_nb_replica_reconciled_errors');
  394. $aData['obj_new_errors'] = $iNewErrors;
  395. $iNew = $aData['obj_created'] + $iNewErrors + $aData['obj_new_updated'] + $aData['obj_new_unchanged'];
  396. $aData['repl_new'] = $iNew;
  397. $iExisting = $oLastLog->Get('stats_nb_replica_seen') - $iNew;
  398. $aData['repl_existing'] = $iExisting;
  399. $aData['obj_unchanged'] = $iExisting - $aData['obj_updated'] - $aData['obj_updated_errors'];
  400. $iIgnored = $oLastLog->Get('stats_nb_replica_total') - $iNew - $iExisting - $iDisappeared;
  401. $aData['repl_ignored'] = $iIgnored;
  402. $aData['nb_obj_total'] = $iNew + $iExisting + $iDisappeared;
  403. $aData['nb_replica_total'] = $aData['nb_obj_total'] + $iIgnored;
  404. return $aData;
  405. }
  406. public function GetIcon($bImgTag = true, $sMoreStyles = '')
  407. {
  408. if ($this->Get('url_icon') == '') return MetaModel::GetClassIcon(get_class($this), $bImgTag);
  409. if ($bImgTag)
  410. {
  411. return "<img src=\"".$this->Get('url_icon')."\" style=\"vertical-align:middle;$sMoreStyles\"/>";
  412. }
  413. return $this->Get('url_icon');
  414. }
  415. /**
  416. * Get the actual hyperlink to the remote application for the given replica and dest object
  417. */
  418. public function GetApplicationUrl(DBObject $oDestObj, SynchroReplica $oReplica)
  419. {
  420. if ($this->Get('url_application') == '') return '';
  421. $aSearches = array();
  422. $aReplacements = array();
  423. foreach(MetaModel::ListAttributeDefs($this->GetTargetClass()) as $sAttCode=>$oAttDef)
  424. {
  425. if ($oAttDef->IsScalar())
  426. {
  427. $aSearches[] = '$this->'.$sAttCode.'$';
  428. $aReplacements[] = $oDestObj->Get($sAttCode);
  429. }
  430. }
  431. $aData = $oReplica->LoadExtendedDataFromTable($this->GetDataTable());
  432. foreach($aData as $sColumn => $value)
  433. {
  434. $aSearches[] = '$replica->'.$sColumn.'$';
  435. $aReplacements[] = $value;
  436. }
  437. return str_replace($aSearches, $aReplacements, $this->Get('url_application'));
  438. }
  439. public function GetAttributeFlags($sAttCode, &$aReasons = array(), $sTargetState = '')
  440. {
  441. if (($sAttCode == 'scope_class') && (!$this->IsNew()))
  442. {
  443. return OPT_ATT_READONLY;
  444. }
  445. return parent::GetAttributeFlags($sAttCode, $aReasons, $sTargetState);
  446. }
  447. public function UpdateObjectFromPostedForm($sFormPrefix = '', $sAttList = null, $sTargetState = '')
  448. {
  449. parent::UpdateObjectFromPostedForm($sFormPrefix, $sAttList, $sTargetState);
  450. // And now read the other post parameters...
  451. $oAttributeSet = $this->Get('attribute_list');
  452. $aAttributes = array();
  453. while($oAttribute = $oAttributeSet->Fetch())
  454. {
  455. $aAttributes[$oAttribute->Get('attcode')] = $oAttribute;
  456. }
  457. $aReconcile = utils::ReadPostedParam('reconciliation', array());
  458. $aUpdate = utils::ReadPostedParam('update', array());
  459. $aUpdatePolicy = utils::ReadPostedParam('attr_update_policy', array());
  460. $aReconciliation = utils::ReadPostedParam('attr_reconciliation_attcode', array());
  461. // update_policy cannot be empty, so there is one entry per attribute, use this to iterate
  462. // through all the writable attributes
  463. foreach($aUpdatePolicy as $sAttCode => $sValue)
  464. {
  465. if(!isset($aAttributes[$sAttCode]))
  466. {
  467. $oAttribute = $this->CreateSynchroAtt($sAttCode);
  468. }
  469. else
  470. {
  471. $oAttribute = $aAttributes[$sAttCode];
  472. }
  473. $bReconcile = 0;
  474. if (isset($aReconcile[$sAttCode]))
  475. {
  476. $bReconcile = $aReconcile[$sAttCode] == 'on' ? 1 : 0;
  477. }
  478. $bUpdate = 0 ; // Default / initial value
  479. if (isset($aUpdate[$sAttCode]))
  480. {
  481. $bUpdate = $aUpdate[$sAttCode] == 'on' ? 1 : 0;
  482. }
  483. $oAttribute->Set('reconcile', $bReconcile);
  484. $oAttribute->Set('update', $bUpdate);
  485. $oAttribute->Set('update_policy', $sValue);
  486. if ($oAttribute instanceof SynchroAttExtKey)
  487. {
  488. $oAttribute->Set('reconciliation_attcode', $aReconciliation[$sAttCode]);
  489. }
  490. elseif ($oAttribute instanceof SynchroAttLinkSet)
  491. {
  492. }
  493. $oAttributeSet->AddObject($oAttribute);
  494. }
  495. $this->Set('attribute_list', $oAttributeSet);
  496. }
  497. /**
  498. * Creates a new SynchroAttXXX object in memory with the default values
  499. */
  500. protected function CreateSynchroAtt($sAttCode)
  501. {
  502. $oAttDef = MetaModel::GetAttributeDef($this->GetTargetClass(), $sAttCode);
  503. if ($oAttDef->IsExternalKey())
  504. {
  505. $oAttribute = new SynchroAttExtKey();
  506. $oAttribute->Set('reconciliation_attcode', ''); // Blank means by pkey
  507. }
  508. elseif ($oAttDef->IsLinkSet() && $oAttDef->IsIndirect())
  509. {
  510. $oAttribute = new SynchroAttLinkSet();
  511. // Todo - set those value from the form
  512. $oAttribute->Set('row_separator', MetaModel::GetConfig()->Get('link_set_item_separator'));
  513. $oAttribute->Set('attribute_separator', MetaModel::GetConfig()->Get('link_set_attribute_separator'));
  514. $oAttribute->Set('value_separator', MetaModel::GetConfig()->Get('link_set_value_separator'));
  515. $oAttribute->Set('attribute_qualifier', MetaModel::GetConfig()->Get('link_set_attribute_qualifier'));
  516. }
  517. else
  518. {
  519. $oAttribute = new SynchroAttribute();
  520. }
  521. $oAttribute->Set('sync_source_id', $this->GetKey());
  522. $oAttribute->Set('attcode', $sAttCode);
  523. $oAttribute->Set('reconcile', 0);
  524. $oAttribute->Set('update', 0);
  525. $oAttribute->Set('update_policy', 'master_locked');
  526. return $oAttribute;
  527. }
  528. /**
  529. * Overload the standard behavior
  530. */
  531. public function ComputeValues()
  532. {
  533. parent::ComputeValues();
  534. if ($this->IsNew())
  535. {
  536. // When inserting a new datasource object, also create the SynchroAttribute objects
  537. // for each field of the target class
  538. // Create all the SynchroAttribute records
  539. $oAttributeSet = $this->Get('attribute_list');
  540. if ($oAttributeSet->Count() == 0)
  541. {
  542. foreach(MetaModel::ListAttributeDefs($this->GetTargetClass()) as $sAttCode=>$oAttDef)
  543. {
  544. if ($oAttDef->IsWritable())
  545. {
  546. $oAttDef = MetaModel::GetAttributeDef($this->GetTargetClass(), $sAttCode);
  547. if ($oAttDef->IsExternalKey())
  548. {
  549. $oAttribute = new SynchroAttExtKey();
  550. $oAttribute->Set('reconciliation_attcode', ''); // Blank means by pkey
  551. }
  552. elseif ($oAttDef->IsLinkSet() && $oAttDef->IsIndirect())
  553. {
  554. $oAttribute = new SynchroAttLinkSet();
  555. // Todo - set those value from the form
  556. $oAttribute->Set('row_separator', MetaModel::GetConfig()->Get('link_set_item_separator'));
  557. $oAttribute->Set('attribute_separator', MetaModel::GetConfig()->Get('link_set_attribute_separator'));
  558. $oAttribute->Set('value_separator', MetaModel::GetConfig()->Get('link_set_value_separator'));
  559. $oAttribute->Set('attribute_qualifier', MetaModel::GetConfig()->Get('link_set_attribute_qualifier'));
  560. }
  561. elseif ($oAttDef->IsScalar())
  562. {
  563. $oAttribute = new SynchroAttribute();
  564. }
  565. else
  566. {
  567. $oAttribute = null;
  568. }
  569. if (!is_null($oAttribute))
  570. {
  571. $oAttribute->Set('sync_source_id', $this->GetKey());
  572. $oAttribute->Set('attcode', $sAttCode);
  573. $oAttribute->Set('reconcile', MetaModel::IsReconcKey($this->GetTargetClass(), $sAttCode) ? 1 : 0);
  574. $oAttribute->Set('update', 1);
  575. $oAttribute->Set('update_policy', 'master_locked');
  576. $oAttributeSet->AddObject($oAttribute);
  577. }
  578. }
  579. }
  580. $this->Set('attribute_list', $oAttributeSet);
  581. }
  582. }
  583. }
  584. public function DoCheckToWrite()
  585. {
  586. parent::DoCheckToWrite();
  587. // Check that there is at least one reconciliation key defined
  588. if ($this->Get('reconciliation_policy') == 'use_attributes')
  589. {
  590. $oSet = $this->Get('attribute_list');
  591. $oSynchroAttributeList = $oSet->ToArray();
  592. $bReconciliationKey = false;
  593. foreach($oSynchroAttributeList as $oSynchroAttribute)
  594. {
  595. if ($oSynchroAttribute->Get('reconcile') == 1)
  596. {
  597. $bReconciliationKey = true; // At least one key is defined
  598. break;
  599. }
  600. }
  601. if (!$bReconciliationKey)
  602. {
  603. $this->m_aCheckIssues[] = Dict::Format('Class:SynchroDataSource/Error:AtLeastOneReconciliationKeyMustBeSpecified');
  604. }
  605. }
  606. // If 'update_then_delete' is specified there must be a delete_retention_period
  607. if (($this->Get('delete_policy') == 'update_then_delete') && ($this->Get('delete_policy_retention') == 0))
  608. {
  609. $this->m_aCheckIssues[] = Dict::Format('Class:SynchroDataSource/Error:DeleteRetentionDurationMustBeSpecified');
  610. }
  611. // If update is specified, then something to update must be defined
  612. if ((($this->Get('delete_policy') == 'update_then_delete') || ($this->Get('delete_policy') == 'update'))
  613. && ($this->Get('delete_policy_update') == ''))
  614. {
  615. $this->m_aCheckIssues[] = Dict::Format('Class:SynchroDataSource/Error:DeletePolicyUpdateMustBeSpecified');
  616. }
  617. }
  618. public function GetTargetClass()
  619. {
  620. return $this->Get('scope_class');
  621. }
  622. public function GetDataTable()
  623. {
  624. $sName = strtolower($this->GetTargetClass());
  625. $sName = str_replace('\'"&@|\\/ ', '_', $sName); // Remove forbidden characters from the table name
  626. $sName .= '_'.$this->GetKey(); // Add a suffix for unicity
  627. $sTable = MetaModel::GetConfig()->GetDBSubName()."synchro_data_$sName"; // Add the prefix if any
  628. return $sTable;
  629. }
  630. /**
  631. * When the new datasource has been created, let's create the synchro_data table
  632. * that will hold the data records and the correspoding triggers which will maintain
  633. * both tables in sync
  634. */
  635. protected function AfterInsert()
  636. {
  637. parent::AfterInsert();
  638. $sTable = $this->GetDataTable();
  639. $sReplicaTable = MetaModel::DBGetTable('SynchroReplica');
  640. $aColumns = $this->GetSQLColumns();
  641. $aFieldDefs = array();
  642. // Allow '0', otherwise mysql will render an error when the id is not given
  643. // (the trigger is expected to set the value, but it is not executed soon enough)
  644. $aFieldDefs[] = "id INTEGER(11) NOT NULL DEFAULT 0 ";
  645. $aFieldDefs[] = "`primary_key` VARCHAR(255) NULL DEFAULT NULL";
  646. foreach($aColumns as $sColumn => $ColSpec)
  647. {
  648. $aFieldDefs[] = "`$sColumn` $ColSpec NULL DEFAULT NULL";
  649. }
  650. $aFieldDefs[] = "INDEX (id)";
  651. $aFieldDefs[] = "INDEX (primary_key)";
  652. $sFieldDefs = implode(', ', $aFieldDefs);
  653. $sCreateTable = "CREATE TABLE `$sTable` ($sFieldDefs) ENGINE = ".MYSQL_ENGINE." CHARACTER SET utf8 COLLATE utf8_unicode_ci;";
  654. CMDBSource::Query($sCreateTable);
  655. $aTriggers = $this->GetTriggersDefinition();
  656. foreach($aTriggers as $key => $sTriggerSQL)
  657. {
  658. CMDBSource::Query($sTriggerSQL);
  659. }
  660. }
  661. /**
  662. * Gets the definitions of the 3 triggers: before insert, before update and after delete
  663. * @return array An array with 3 entries, one for each of the SQL queries
  664. */
  665. protected function GetTriggersDefinition()
  666. {
  667. $sTable = $this->GetDataTable();
  668. $sReplicaTable = MetaModel::DBGetTable('SynchroReplica');
  669. $aColumns = $this->GetSQLColumns();
  670. $aResult = array();
  671. $sTriggerInsert = "CREATE TRIGGER `{$sTable}_bi` BEFORE INSERT ON `$sTable`";
  672. $sTriggerInsert .= " FOR EACH ROW";
  673. $sTriggerInsert .= " BEGIN";
  674. $sTriggerInsert .= " INSERT INTO `{$sReplicaTable}` (`sync_source_id`, `status_last_seen`, `status`) VALUES ({$this->GetKey()}, NOW(), 'new');";
  675. $sTriggerInsert .= " SET NEW.id = LAST_INSERT_ID();";
  676. $sTriggerInsert .= " END;";
  677. $aResult['bi'] = $sTriggerInsert;
  678. $aModified = array();
  679. foreach($aColumns as $sColumn => $ColSpec)
  680. {
  681. // <=> is a null-safe 'EQUALS' operator (there is no equivalent for "DIFFERS FROM")
  682. $aModified[] = "NOT(NEW.`$sColumn` <=> OLD.`$sColumn`)";
  683. }
  684. $sIsModified = '('.implode(') OR (', $aModified).')';
  685. // Update the replica
  686. //
  687. // status is forced to "new" if the replica was obsoleted directly from the state "new" (dest_id = null)
  688. // otherwise, if status was either 'obsolete' or 'synchronized' it is turned into 'modified' or 'synchronized' depending on the changes
  689. // otherwise, the status is left as is
  690. $sTriggerUpdate = "CREATE TRIGGER `{$sTable}_bu` BEFORE UPDATE ON `$sTable`";
  691. $sTriggerUpdate .= " FOR EACH ROW";
  692. $sTriggerUpdate .= " BEGIN";
  693. $sTriggerUpdate .= " IF @itopuser is null THEN";
  694. $sTriggerUpdate .= " UPDATE `{$sReplicaTable}` SET status_last_seen = NOW(), `status` = IF(`status` = 'obsolete', IF(`dest_id` IS NULL, 'new', 'modified'), IF(`status` IN ('synchronized') AND ($sIsModified), 'modified', `status`)) WHERE sync_source_id = {$this->GetKey()} AND id = OLD.id;";
  695. $sTriggerUpdate .= " SET NEW.id = OLD.id;"; // make sure this id won't change
  696. $sTriggerUpdate .= " END IF;";
  697. $sTriggerUpdate .= " END;";
  698. $aResult['bu'] = $sTriggerUpdate;
  699. $sTriggerDelete = "CREATE TRIGGER `{$sTable}_ad` AFTER DELETE ON `$sTable`";
  700. $sTriggerDelete .= " FOR EACH ROW";
  701. $sTriggerDelete .= " BEGIN";
  702. $sTriggerDelete .= " DELETE FROM `{$sReplicaTable}` WHERE id = OLD.id;";
  703. $sTriggerDelete .= " END;";
  704. $aResult['ad'] = $sTriggerDelete;
  705. return $aResult;
  706. }
  707. protected function AfterDelete()
  708. {
  709. parent::AfterDelete();
  710. $sTable = $this->GetDataTable();
  711. $sDropTable = "DROP TABLE `$sTable`";
  712. CMDBSource::Query($sDropTable);
  713. // TO DO - check that triggers get dropped with the table
  714. }
  715. /**
  716. * Checks if the data source definition is consistent with the schema of the target class
  717. * @param $bDiagnostics boolean True to only diagnose the consistency, false to actually apply some changes
  718. * @param $bVerbose boolean True to get some information in the std output (echo)
  719. * @return bool Whether or not the database needs fixing for this data source
  720. */
  721. public function CheckDBConsistency($bDiagnostics, $bVerbose, $oChange = null)
  722. {
  723. $bFixNeeded = false;
  724. $aMissingFields = array();
  725. $oAttributeSet = $this->Get('attribute_list');
  726. $aAttributes = array();
  727. while($oAttribute = $oAttributeSet->Fetch())
  728. {
  729. $sAttCode = $oAttribute->Get('attcode');
  730. if (MetaModel::IsValidAttCode($this->GetTargetClass(), $sAttCode))
  731. {
  732. $aAttributes[$sAttCode] = $oAttribute;
  733. }
  734. else
  735. {
  736. // Old field remaining
  737. if ($bVerbose)
  738. {
  739. echo "Irrelevant field description for the field '$sAttCode', for the data synchro task ".$this->GetName()." (".$this->GetKey()."), will be removed.\n";
  740. }
  741. $bFixNeeded = true;
  742. if (!$bDiagnostics)
  743. {
  744. if ($oChange == null)
  745. {
  746. $oChange = MetaModel::NewObject("CMDBChange");
  747. $oChange->Set("date", time());
  748. $sUserString = CMDBChange::GetCurrentUserName();
  749. $oChange->Set("userinfo", $sUserString);
  750. $oChange->DBInsert();
  751. }
  752. // Fix the issue
  753. $oAttribute->DBDeleteTracked($oChange);
  754. }
  755. }
  756. }
  757. $sTable = $this->GetDataTable();
  758. foreach($this->ListTargetAttributes() as $sAttCode=>$oAttDef)
  759. {
  760. if (!isset($aAttributes[$sAttCode]))
  761. {
  762. $bFixNeeded = true;
  763. $aMissingFields[] = $sAttCode;
  764. // New field missing...
  765. if ($bVerbose)
  766. {
  767. echo "Missing field description for the field '$sAttCode', for the data synchro task ".$this->GetName()." (".$this->GetKey()."), will be created with default values.\n";
  768. }
  769. if (!$bDiagnostics)
  770. {
  771. if ($oChange == null)
  772. {
  773. $oChange = MetaModel::NewObject("CMDBChange");
  774. $oChange->Set("date", time());
  775. $sUserString = CMDBChange::GetCurrentUserName();
  776. $oChange->Set("userinfo", $sUserString);
  777. $oChange->DBInsert();
  778. }
  779. // Fix the issue
  780. $oAttribute = $this->CreateSynchroAtt($sAttCode);
  781. $oAttribute->DBInsertTracked($oChange);
  782. }
  783. }
  784. else
  785. {
  786. $aColumns = $this->GetSQLColumns(array($sAttCode));
  787. foreach($aColumns as $sColName => $sColumnDef)
  788. {
  789. $bOneColIsMissing = false;
  790. if (!CMDBSource::IsField($sTable, $sColName))
  791. {
  792. $bFixNeeded = true;
  793. $bOneColIsMissing = true;
  794. if ($bVerbose)
  795. {
  796. if (count($aColumns) > 1)
  797. {
  798. echo "Missing column '$sColName', in the table '$sTable' for the data synchro task ".$this->GetName()." (".$this->GetKey()."). The columns '".implode("', '", $aColumns )." will be re-created.'.\n";
  799. }
  800. else
  801. {
  802. echo "Missing column '$sColName', in the table '$sTable' for the data synchro task ".$this->GetName()." (".$this->GetKey()."). The column '$sColName' will be added.\n";
  803. }
  804. }
  805. }
  806. else if (strcasecmp(CMDBSource::GetFieldType($sTable, $sColName), $sColumnDef) != 0)
  807. {
  808. $bFixNeeded = true;
  809. $bOneColIsMissing = true;
  810. if (count($aColumns) > 1)
  811. {
  812. echo "Incorrect column '$sColName' (".CMDBSource::GetFieldType($sTable, $sColName)." instead of ".$sColumnDef."), in the table '$sTable' for the data synchro task ".$this->GetName()." (".$this->GetKey()."). The columns '".implode("', '", $aColumns )." will be re-created.'.\n";
  813. }
  814. else
  815. {
  816. echo "Incorrect column '$sColName' (".CMDBSource::GetFieldType($sTable, $sColName)." instead of ".$sColumnDef."), in the table '$sTable' for the data synchro task ".$this->GetName()." (".$this->GetKey()."). The column '$sColName' will be added.\n";
  817. }
  818. }
  819. if ($bOneColIsMissing)
  820. {
  821. $aMissingFields[] = $sAttCode;
  822. }
  823. }
  824. }
  825. }
  826. if ($bFixNeeded && (count($aMissingFields) > 0))
  827. {
  828. $aRepairQueries = array();
  829. // The structure of the table needs adjusting
  830. $aColumns = $this->GetSQLColumns($aMissingFields);
  831. $aFieldDefs = array();
  832. foreach($aColumns as $sAttCode => $sColumnDef)
  833. {
  834. if (CMDBSource::IsField($sTable, $sAttCode))
  835. {
  836. $aRepairQueries[] = "ALTER TABLE `$sTable` CHANGE `$sAttCode` `$sAttCode` $sColumnDef";
  837. }
  838. else
  839. {
  840. $aFieldDefs[] = "`$sAttCode` $sColumnDef";
  841. }
  842. }
  843. if (count($aFieldDefs) > 0)
  844. {
  845. $aRepairQueries[] = "ALTER TABLE `$sTable` ADD (".implode(',', $aFieldDefs).");";
  846. }
  847. // The triggers as well must be adjusted
  848. $aTriggersDefs = $this->GetTriggersDefinition();
  849. $aRepairQueries[] = "DROP TRIGGER IF EXISTS `{$sTable}_bi`;";
  850. $aRepairQueries[] = $aTriggersDefs['bi'];
  851. $aRepairQueries[] = "DROP TRIGGER IF EXISTS `{$sTable}_bu`;";
  852. $aRepairQueries[] = $aTriggersDefs['bu'];
  853. $aRepairQueries[] = "DROP TRIGGER IF EXISTS `{$sTable}_ad`;";
  854. $aRepairQueries[] = $aTriggersDefs['ad'];
  855. if ($bDiagnostics)
  856. {
  857. if ($bVerbose)
  858. {
  859. // Report the issue
  860. echo "The structure of the table $sTable for the data synchro task ".$this->GetName()." (".$this->GetKey().") must be altered (missing or incorrect fields: ".implode(',', $aMissingFields).").\n";
  861. echo "The trigger {$sTable}_bi, {$sTable}_bu, {$sTable}_ad for the data synchro task ".$this->GetName()." (".$this->GetKey().") must be re-created.\n";
  862. echo implode("\n", $aRepairQueries)."\n";
  863. }
  864. }
  865. else
  866. {
  867. // Fix the issue
  868. foreach($aRepairQueries as $sSQL)
  869. {
  870. CMDBSource::Query($sSQL);
  871. if ($bVerbose)
  872. {
  873. echo "$sSQL\n";
  874. }
  875. }
  876. }
  877. }
  878. return $bFixNeeded;
  879. }
  880. public function SendNotification($sSubject, $sBody)
  881. {
  882. $iContact = $this->Get('notify_contact_id');
  883. if ($iContact == 0)
  884. {
  885. // Leave silently...
  886. return;
  887. }
  888. $oContact = MetaModel::GetObject('Contact', $iContact);
  889. // Determine the email attribute (the first one will be our choice)
  890. $sEmailAttCode = null;
  891. foreach (MetaModel::ListAttributeDefs(get_class($oContact)) as $sAttCode => $oAttDef)
  892. {
  893. if ($oAttDef instanceof AttributeEmailAddress)
  894. {
  895. $sEmailAttCode = $sAttCode;
  896. // we've got one, exit the loop
  897. break;
  898. }
  899. }
  900. if (is_null($sEmailAttCode))
  901. {
  902. // Leave silently...
  903. return;
  904. }
  905. $sTo = $oContact->Get($sEmailAttCode);
  906. $sFrom = $sTo;
  907. $sBody = '<p>Data synchronization: '.$this->GetHyperlink().'</p>'.$sBody;
  908. $sSubject = 'iTop Data Sync - '.$this->GetName().' - '.$sSubject;
  909. $oEmail = new Email();
  910. $oEmail->SetRecipientTO($sTo);
  911. $oEmail->SetRecipientFrom($sFrom);
  912. $oEmail->SetSubject($sSubject);
  913. $oEmail->SetBody($sBody);
  914. if ($oEmail->Send($aIssues) == EMAIL_SEND_ERROR)
  915. {
  916. // mmmm, what can I do?
  917. }
  918. }
  919. /**
  920. * Get the list of attributes eligible to the synchronization
  921. */
  922. public function ListTargetAttributes()
  923. {
  924. $aRet = array();
  925. foreach(MetaModel::ListAttributeDefs($this->GetTargetClass()) as $sAttCode => $oAttDef)
  926. {
  927. if ($sAttCode == 'finalclass') continue;
  928. if (!$oAttDef->IsWritable()) continue;
  929. if ($oAttDef->IsLinkSet() && !$oAttDef->IsIndirect()) continue;
  930. $aRet[$sAttCode] = $oAttDef;
  931. }
  932. return $aRet;
  933. }
  934. /**
  935. * Get the list of SQL columns corresponding to a particular list of attribute codes
  936. * Defaults to the whole list of columns for the current class
  937. */
  938. public function GetSQLColumns($aAttributeCodes = null)
  939. {
  940. $aColumns = array();
  941. $sClass = $this->GetTargetClass();
  942. if (is_null($aAttributeCodes))
  943. {
  944. $aAttributeCodes = array();
  945. foreach($this->ListTargetAttributes() as $sAttCode => $oAttDef)
  946. {
  947. $aAttributeCodes[] = $sAttCode;
  948. }
  949. }
  950. foreach($aAttributeCodes as $sAttCode)
  951. {
  952. $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
  953. if ($oAttDef->IsExternalKey())
  954. {
  955. // The pkey might be used as well as any other key column
  956. $aColumns[$sAttCode] = 'VARCHAR(255)';
  957. }
  958. else
  959. {
  960. foreach($oAttDef->GetImportColumns() as $sField => $sDBFieldType)
  961. {
  962. $aColumns[$sField] = $sDBFieldType;
  963. }
  964. }
  965. }
  966. return $aColumns;
  967. }
  968. /**
  969. * Get the list of Date and Datetime SQL columns
  970. */
  971. public function GetDateSQLColumns()
  972. {
  973. $aDateAttributes = array();
  974. $sClass = $this->GetTargetClass();
  975. foreach(MetaModel::ListAttributeDefs($sClass) as $sAttCode => $oAttDef)
  976. {
  977. if ($oAttDef instanceof AttributeDateTime)
  978. {
  979. $aDateAttributes[] = $sAttCode;
  980. }
  981. }
  982. return $this->GetSQLColumns($aDateAttributes);
  983. }
  984. public function IsRunning()
  985. {
  986. $sOQL = "SELECT SynchroLog WHERE sync_source_id = :source_id AND status='running'";
  987. $oSet = new DBObjectSet(DBObjectSearch::FromOQL($sOQL), array('start_date' => false) /* order by*/, array('source_id' => $this->GetKey()) /* aArgs */, array(), 1 /* limitCount */, 0 /* limitStart */);
  988. if ($oSet->Count() < 1)
  989. {
  990. $bRet = false;
  991. }
  992. else
  993. {
  994. $bRet = true;
  995. }
  996. return $bRet;
  997. }
  998. public function GetLatestLog()
  999. {
  1000. $oLog = null;
  1001. $sOQL = "SELECT SynchroLog WHERE sync_source_id = :source_id";
  1002. $oSet = new DBObjectSet(DBObjectSearch::FromOQL($sOQL), array('start_date' => false) /* order by*/, array('source_id' => $this->GetKey()) /* aArgs */, array(), 1 /* limitCount */, 0 /* limitStart */);
  1003. if ($oSet->Count() >= 1)
  1004. {
  1005. $oLog = $oSet->Fetch();
  1006. }
  1007. return $oLog;
  1008. }
  1009. // TO DO: remove if still unused
  1010. /**
  1011. * Retrieve from the log, the date of the last completed import
  1012. * @return DateTime
  1013. */
  1014. public function GetLastCompletedImportDate()
  1015. {
  1016. $date = null;
  1017. $sOQL = "SELECT SynchroLog WHERE sync_source_id = :source_id AND status='completed'";
  1018. $oSet = new DBObjectSet(DBObjectSearch::FromOQL($sOQL), array('end_date' => false) /* order by*/, array('source_id' => $this->GetKey()) /* aArgs */, array(), 0 /* limitCount */, 0 /* limitStart */);
  1019. if ($oSet->Count() >= 1)
  1020. {
  1021. $oLog = $oSet->Fetch();
  1022. $date = $oLog->Get('end_date');
  1023. }
  1024. return $date;
  1025. }
  1026. }
  1027. class SynchroAttribute extends cmdbAbstractObject
  1028. {
  1029. public static function Init()
  1030. {
  1031. $aParams = array
  1032. (
  1033. "category" => "core/cmdb,view_in_gui",
  1034. "key_type" => "autoincrement",
  1035. "name_attcode" => "",
  1036. "state_attcode" => "",
  1037. "reconc_keys" => array(),
  1038. "db_table" => "priv_sync_att",
  1039. "db_key_field" => "id",
  1040. "db_finalclass_field" => "",
  1041. "display_template" => "",
  1042. );
  1043. MetaModel::Init_Params($aParams);
  1044. MetaModel::Init_InheritAttributes();
  1045. MetaModel::Init_AddAttribute(new AttributeExternalKey("sync_source_id", array("targetclass"=>"SynchroDataSource", "jointype"=> "", "allowed_values"=>null, "sql"=>"sync_source_id", "is_null_allowed"=>false, "on_target_delete"=>DEL_SILENT, "depends_on"=>array())));
  1046. MetaModel::Init_AddAttribute(new AttributeExternalField("sync_source_name", array("allowed_values"=>null, "extkey_attcode"=> 'sync_source_id', "target_attcode"=>"name")));
  1047. MetaModel::Init_AddAttribute(new AttributeString("attcode", array("allowed_values"=>null, "sql"=>"attcode", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
  1048. MetaModel::Init_AddAttribute(new AttributeBoolean("update", array("allowed_values"=>null, "sql"=>"update", "default_value"=>true, "is_null_allowed"=>false, "depends_on"=>array())));
  1049. MetaModel::Init_AddAttribute(new AttributeBoolean("reconcile", array("allowed_values"=>null, "sql"=>"reconcile", "default_value"=>false, "is_null_allowed"=>false, "depends_on"=>array())));
  1050. MetaModel::Init_AddAttribute(new AttributeEnum("update_policy", array("allowed_values"=>new ValueSetEnum('master_locked,master_unlocked,write_if_empty'), "sql"=>"update_policy", "default_value"=>"master_locked", "is_null_allowed"=>false, "depends_on"=>array())));
  1051. // Display lists
  1052. MetaModel::Init_SetZListItems('details', array('sync_source_id', 'attcode', 'update', 'reconcile', 'update_policy')); // Attributes to be displayed for the complete details
  1053. MetaModel::Init_SetZListItems('list', array('sync_source_id', 'attcode', 'update', 'reconcile', 'update_policy')); // Attributes to be displayed for a list
  1054. // Search criteria
  1055. // MetaModel::Init_SetZListItems('standard_search', array('name')); // Criteria of the std search form
  1056. // MetaModel::Init_SetZListItems('advanced_search', array('name')); // Criteria of the advanced search form
  1057. }
  1058. }
  1059. class SynchroAttExtKey extends SynchroAttribute
  1060. {
  1061. public static function Init()
  1062. {
  1063. $aParams = array
  1064. (
  1065. "category" => "core/cmdb,view_in_gui",
  1066. "key_type" => "autoincrement",
  1067. "name_attcode" => "",
  1068. "state_attcode" => "",
  1069. "reconc_keys" => array(),
  1070. "db_table" => "priv_sync_att_extkey",
  1071. "db_key_field" => "id",
  1072. "db_finalclass_field" => "",
  1073. "display_template" => "",
  1074. );
  1075. MetaModel::Init_Params($aParams);
  1076. MetaModel::Init_InheritAttributes();
  1077. MetaModel::Init_AddAttribute(new AttributeString("reconciliation_attcode", array("allowed_values"=>null, "sql"=>"reconciliation_attcode", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
  1078. // Display lists
  1079. MetaModel::Init_SetZListItems('details', array('sync_source_id', 'attcode', 'update', 'reconcile', 'update_policy', 'reconciliation_attcode')); // Attributes to be displayed for the complete details
  1080. MetaModel::Init_SetZListItems('list', array('sync_source_id', 'attcode', 'update', 'reconcile', 'update_policy')); // Attributes to be displayed for a list
  1081. // Search criteria
  1082. // MetaModel::Init_SetZListItems('standard_search', array('name')); // Criteria of the std search form
  1083. // MetaModel::Init_SetZListItems('advanced_search', array('name')); // Criteria of the advanced search form
  1084. }
  1085. public function GetReconciliationFormElement($sTargetClass, $sFieldName)
  1086. {
  1087. $sHtml = "<select name=\"$sFieldName\">\n";
  1088. $sSelected = (''== $this->Get('reconciliation_attcode')) ? ' selected' : '';
  1089. $sHtml .= "<option value=\"\" $sSelected>".Dict::S('Core:SynchroAttExtKey:ReconciliationById')."</option>\n";
  1090. foreach(MetaModel::ListAttributeDefs($sTargetClass) as $sAttCode => $oAttDef)
  1091. {
  1092. if ($oAttDef->IsScalar())
  1093. {
  1094. $sSelected = ($sAttCode == $this->Get('reconciliation_attcode')) ? ' selected' : '';
  1095. $sHtml .= "<option value=\"$sAttCode\" $sSelected>".MetaModel::GetLabel($sTargetClass, $sAttCode)."</option>\n";
  1096. }
  1097. }
  1098. $sHtml .= "</select>\n";
  1099. return $sHtml;
  1100. }
  1101. }
  1102. class SynchroAttLinkSet extends SynchroAttribute
  1103. {
  1104. public static function Init()
  1105. {
  1106. $aParams = array
  1107. (
  1108. "category" => "core/cmdb,view_in_gui",
  1109. "key_type" => "autoincrement",
  1110. "name_attcode" => "",
  1111. "state_attcode" => "",
  1112. "reconc_keys" => array(),
  1113. "db_table" => "priv_sync_att_linkset",
  1114. "db_key_field" => "id",
  1115. "db_finalclass_field" => "",
  1116. "display_template" => "",
  1117. );
  1118. MetaModel::Init_Params($aParams);
  1119. MetaModel::Init_InheritAttributes();
  1120. MetaModel::Init_AddAttribute(new AttributeString("row_separator", array("allowed_values"=>null, "sql"=>"row_separator", "default_value"=>'|', "is_null_allowed"=>true, "depends_on"=>array())));
  1121. MetaModel::Init_AddAttribute(new AttributeString("attribute_separator", array("allowed_values"=>null, "sql"=>"attribute_separator", "default_value"=>';', "is_null_allowed"=>true, "depends_on"=>array())));
  1122. MetaModel::Init_AddAttribute(new AttributeString("value_separator", array("allowed_values"=>null, "sql"=>"value_separator", "default_value"=>':', "is_null_allowed"=>true, "depends_on"=>array())));
  1123. MetaModel::Init_AddAttribute(new AttributeString("attribute_qualifier", array("allowed_values"=>null, "sql"=>"attribute_qualifier", "default_value"=>'\'', "is_null_allowed"=>true, "depends_on"=>array())));
  1124. // Display lists
  1125. MetaModel::Init_SetZListItems('details', array('sync_source_id', 'attcode', 'update', 'reconcile', 'update_policy', 'row_separator', 'attribute_separator', 'value_separator', 'attribute_qualifier')); // Attributes to be displayed for the complete details
  1126. MetaModel::Init_SetZListItems('list', array('sync_source_id', 'attcode', 'update', 'reconcile', 'update_policy')); // Attributes to be displayed for a list
  1127. // Search criteria
  1128. // MetaModel::Init_SetZListItems('standard_search', array('name')); // Criteria of the std search form
  1129. // MetaModel::Init_SetZListItems('advanced_search', array('name')); // Criteria of the advanced search form
  1130. }
  1131. }
  1132. //class SynchroLog extends Event
  1133. class SynchroLog extends DBObject
  1134. {
  1135. public static function Init()
  1136. {
  1137. $aParams = array
  1138. (
  1139. "category" => "core/cmdb,view_in_gui",
  1140. "key_type" => "autoincrement",
  1141. "name_attcode" => "",
  1142. "state_attcode" => "",
  1143. "reconc_keys" => array(),
  1144. "db_table" => "priv_sync_log",
  1145. "db_key_field" => "id",
  1146. "db_finalclass_field" => "",
  1147. "display_template" => "",
  1148. );
  1149. MetaModel::Init_Params($aParams);
  1150. MetaModel::Init_InheritAttributes();
  1151. // MetaModel::Init_AddAttribute(new AttributeString("userinfo", array("allowed_values"=>null, "sql"=>"userinfo", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
  1152. MetaModel::Init_AddAttribute(new AttributeExternalKey("sync_source_id", array("targetclass"=>"SynchroDataSource", "jointype"=> "", "allowed_values"=>null, "sql"=>"sync_source_id", "is_null_allowed"=>false, "on_target_delete"=>DEL_SILENT, "depends_on"=>array())));
  1153. MetaModel::Init_AddAttribute(new AttributeDateTime("start_date", array("allowed_values"=>null, "sql"=>"start_date", "default_value"=>"", "is_null_allowed"=>true, "depends_on"=>array())));
  1154. MetaModel::Init_AddAttribute(new AttributeDateTime("end_date", array("allowed_values"=>null, "sql"=>"end_date", "default_value"=>"", "is_null_allowed"=>true, "depends_on"=>array())));
  1155. MetaModel::Init_AddAttribute(new AttributeEnum("status", array("allowed_values"=>new ValueSetEnum('running,completed,error'), "sql"=>"status", "default_value"=>"running", "is_null_allowed"=>false, "depends_on"=>array())));
  1156. MetaModel::Init_AddAttribute(new AttributeInteger("status_curr_job", array("allowed_values"=>null, "sql"=>"status_curr_job", "default_value"=>0, "is_null_allowed"=>true, "depends_on"=>array())));
  1157. MetaModel::Init_AddAttribute(new AttributeInteger("status_curr_pos", array("allowed_values"=>null, "sql"=>"status_curr_pos", "default_value"=>0, "is_null_allowed"=>true, "depends_on"=>array())));
  1158. MetaModel::Init_AddAttribute(new AttributeInteger("stats_nb_replica_seen", array("allowed_values"=>null, "sql"=>"stats_nb_replica_seen", "default_value"=>0, "is_null_allowed"=>false, "depends_on"=>array())));
  1159. MetaModel::Init_AddAttribute(new AttributeInteger("stats_nb_replica_total", array("allowed_values"=>null, "sql"=>"stats_nb_replica_total", "default_value"=>0, "is_null_allowed"=>false, "depends_on"=>array())));
  1160. MetaModel::Init_AddAttribute(new AttributeInteger("stats_nb_obj_deleted", array("allowed_values"=>null, "sql"=>"stats_nb_obj_deleted", "default_value"=>0, "is_null_allowed"=>false, "depends_on"=>array())));
  1161. MetaModel::Init_AddAttribute(new AttributeInteger("stats_nb_obj_deleted_errors", array("allowed_values"=>null, "sql"=>"stats_deleted_errors", "default_value"=>0, "is_null_allowed"=>false, "depends_on"=>array())));
  1162. MetaModel::Init_AddAttribute(new AttributeInteger("stats_nb_obj_obsoleted", array("allowed_values"=>null, "sql"=>"stats_nb_obj_obsoleted", "default_value"=>0, "is_null_allowed"=>false, "depends_on"=>array())));
  1163. MetaModel::Init_AddAttribute(new AttributeInteger("stats_nb_obj_obsoleted_errors", array("allowed_values"=>null, "sql"=>"stats_nb_obj_obsoleted_errors", "default_value"=>0, "is_null_allowed"=>false, "depends_on"=>array())));
  1164. MetaModel::Init_AddAttribute(new AttributeInteger("stats_nb_obj_created", array("allowed_values"=>null, "sql"=>"stats_nb_obj_created", "default_value"=>0, "is_null_allowed"=>false, "depends_on"=>array())));
  1165. MetaModel::Init_AddAttribute(new AttributeInteger("stats_nb_obj_created_errors", array("allowed_values"=>null, "sql"=>"stats_nb_obj_created_errors", "default_value"=>0, "is_null_allowed"=>false, "depends_on"=>array())));
  1166. MetaModel::Init_AddAttribute(new AttributeInteger("stats_nb_obj_created_warnings", array("allowed_values"=>null, "sql"=>"stats_nb_obj_created_warnings", "default_value"=>0, "is_null_allowed"=>false, "depends_on"=>array())));
  1167. MetaModel::Init_AddAttribute(new AttributeInteger("stats_nb_obj_updated", array("allowed_values"=>null, "sql"=>"stats_nb_obj_updated", "default_value"=>0, "is_null_allowed"=>false, "depends_on"=>array())));
  1168. MetaModel::Init_AddAttribute(new AttributeInteger("stats_nb_obj_updated_errors", array("allowed_values"=>null, "sql"=>"stats_nb_obj_updated_errors", "default_value"=>0, "is_null_allowed"=>false, "depends_on"=>array())));
  1169. MetaModel::Init_AddAttribute(new AttributeInteger("stats_nb_obj_updated_warnings", array("allowed_values"=>null, "sql"=>"stats_nb_obj_updated_warnings", "default_value"=>0, "is_null_allowed"=>false, "depends_on"=>array())));
  1170. MetaModel::Init_AddAttribute(new AttributeInteger("stats_nb_obj_unchanged_warnings", array("allowed_values"=>null, "sql"=>"stats_nb_obj_unchanged_warnings", "default_value"=>0, "is_null_allowed"=>false, "depends_on"=>array())));
  1171. // MetaModel::Init_AddAttribute(new AttributeInteger("stats_nb_replica_reconciled", array("allowed_values"=>null, "sql"=>"stats_nb_replica_reconciled", "default_value"=>0, "is_null_allowed"=>false, "depends_on"=>array())));
  1172. MetaModel::Init_AddAttribute(new AttributeInteger("stats_nb_replica_reconciled_errors", array("allowed_values"=>null, "sql"=>"stats_nb_replica_reconciled_errors", "default_value"=>0, "is_null_allowed"=>false, "depends_on"=>array())));
  1173. MetaModel::Init_AddAttribute(new AttributeInteger("stats_nb_replica_disappeared_no_action", array("allowed_values"=>null, "sql"=>"stats_nb_replica_disappeared_no_action", "default_value"=>0, "is_null_allowed"=>false, "depends_on"=>array())));
  1174. MetaModel::Init_AddAttribute(new AttributeInteger("stats_nb_obj_new_updated", array("allowed_values"=>null, "sql"=>"stats_nb_obj_new_updated", "default_value"=>0, "is_null_allowed"=>false, "depends_on"=>array())));
  1175. MetaModel::Init_AddAttribute(new AttributeInteger("stats_nb_obj_new_updated_warnings", array("allowed_values"=>null, "sql"=>"stats_nb_obj_new_updated_warnings", "default_value"=>0, "is_null_allowed"=>false, "depends_on"=>array())));
  1176. MetaModel::Init_AddAttribute(new AttributeInteger("stats_nb_obj_new_unchanged", array("allowed_values"=>null, "sql"=>"stats_nb_obj_new_unchanged", "default_value"=>0, "is_null_allowed"=>false, "depends_on"=>array())));
  1177. MetaModel::Init_AddAttribute(new AttributeInteger("stats_nb_obj_new_unchanged_warnings", array("allowed_values"=>null, "sql"=>"stats_nb_obj_new_unchanged_warnings", "default_value"=>0, "is_null_allowed"=>false, "depends_on"=>array())));
  1178. MetaModel::Init_AddAttribute(new AttributeText("last_error", array("allowed_values"=>null, "sql"=>"last_error", "default_value"=>'', "is_null_allowed"=>true, "depends_on"=>array())));
  1179. MetaModel::Init_AddAttribute(new AttributeLongText("traces", array("allowed_values"=>null, "sql"=>"traces", "default_value"=>'', "is_null_allowed"=>true, "depends_on"=>array())));
  1180. MetaModel::Init_AddAttribute(new AttributeInteger("memory_usage_peak", array("allowed_values"=>null, "sql"=>"memory_usage_peak", "default_value"=>0, "is_null_allowed"=>false, "depends_on"=>array())));
  1181. // Display lists
  1182. MetaModel::Init_SetZListItems('details', array('sync_source_id', 'start_date', 'end_date', 'status', 'stats_nb_replica_total', 'stats_nb_replica_seen', 'stats_nb_obj_created', /*'stats_nb_replica_reconciled',*/ 'stats_nb_obj_updated', 'stats_nb_obj_obsoleted', 'stats_nb_obj_deleted',
  1183. 'stats_nb_obj_created_errors', 'stats_nb_replica_reconciled_errors', 'stats_nb_replica_disappeared_no_action', 'stats_nb_obj_updated_errors', 'stats_nb_obj_obsoleted_errors', 'stats_nb_obj_deleted_errors', 'stats_nb_obj_new_unchanged', 'stats_nb_obj_new_updated', 'traces')); // Attributes to be displayed for the complete details
  1184. MetaModel::Init_SetZListItems('list', array('sync_source_id', 'start_date', 'end_date', 'status', 'stats_nb_replica_seen')); // Attributes to be displayed for a list
  1185. // Search criteria
  1186. // MetaModel::Init_SetZListItems('standard_search', array('name')); // Criteria of the std search form
  1187. // MetaModel::Init_SetZListItems('advanced_search', array('name')); // Criteria of the advanced search form
  1188. }
  1189. /**
  1190. * Helper
  1191. */
  1192. function GetErrorCount()
  1193. {
  1194. return $this->Get('stats_nb_obj_deleted_errors')
  1195. + $this->Get('stats_nb_obj_obsoleted_errors')
  1196. + $this->Get('stats_nb_obj_created_errors')
  1197. + $this->Get('stats_nb_obj_updated_errors')
  1198. + $this->Get('stats_nb_replica_reconciled_errors');
  1199. }
  1200. /**
  1201. * Increments a statistics counter
  1202. */
  1203. function Inc($sCode)
  1204. {
  1205. $this->Set($sCode, 1+$this->Get($sCode));
  1206. }
  1207. /**
  1208. * Implement traces management
  1209. */
  1210. protected $m_aTraces = array();
  1211. public function AddTrace($sMsg, $oReplica = null)
  1212. {
  1213. if (MetaModel::GetConfig()->Get('synchro_trace') == 'none')
  1214. {
  1215. return;
  1216. }
  1217. if ($oReplica)
  1218. {
  1219. $sDestClass = $oReplica->Get('dest_class');
  1220. if (!empty($sDestClass))
  1221. {
  1222. $sPrefix = $oReplica->GetKey().','.$sDestClass.'::'.$oReplica->Get('dest_id').',';
  1223. }
  1224. else
  1225. {
  1226. $sPrefix = $oReplica->GetKey().',,';
  1227. }
  1228. }
  1229. else
  1230. {
  1231. $sPrefix = ',,';
  1232. }
  1233. $this->m_aTraces[] = $sPrefix.$sMsg;
  1234. }
  1235. public function GetTraces()
  1236. {
  1237. return $this->m_aTraces;
  1238. }
  1239. protected function TraceToText()
  1240. {
  1241. if (MetaModel::GetConfig()->Get('synchro_trace') != 'save')
  1242. {
  1243. // none, or display only
  1244. return;
  1245. }
  1246. $sPrevTrace = $this->Get('traces');
  1247. $oAttDef = MetaModel::GetAttributeDef(get_class($this), 'traces');
  1248. $iMaxSize = $oAttDef->GetMaxSize();
  1249. if (strlen($sPrevTrace) > 0)
  1250. {
  1251. $sTrace = $sPrevTrace."\n".implode("\n", $this->m_aTraces);
  1252. }
  1253. else
  1254. {
  1255. $sTrace = implode("\n", $this->m_aTraces);
  1256. }
  1257. if (strlen($sTrace) >= $iMaxSize)
  1258. {
  1259. $sTrace = substr($sTrace, 0, $iMaxSize - 255)."...\nTruncated (size: ".strlen($sTrace).')';
  1260. }
  1261. $this->Set('traces', $sTrace);
  1262. //DBUpdate may be called many times... the operation should not be repeated
  1263. $this->m_aTraces = array();
  1264. }
  1265. protected function OnInsert()
  1266. {
  1267. $this->TraceToText();
  1268. parent::OnInsert();
  1269. }
  1270. protected function OnUpdate()
  1271. {
  1272. $this->TraceToText();
  1273. $sMemPeak = max($this->Get('memory_usage_peak'), ExecutionKPI::memory_get_peak_usage());
  1274. $this->Set('memory_usage_peak', $sMemPeak);
  1275. parent::OnUpdate();
  1276. }
  1277. }
  1278. class SynchroReplica extends DBObject implements iDisplay
  1279. {
  1280. static $aSearches = array(); // Cache of OQL queries used for reconciliation (per data source)
  1281. protected $aWarnings;
  1282. public static function Init()
  1283. {
  1284. $aParams = array
  1285. (
  1286. "category" => "core/cmdb,view_in_gui",
  1287. "key_type" => "autoincrement",
  1288. "name_attcode" => "",
  1289. "state_attcode" => "",
  1290. "reconc_keys" => array(),
  1291. "db_table" => "priv_sync_replica",
  1292. "db_key_field" => "id",
  1293. "db_finalclass_field" => "",
  1294. "display_template" => "",
  1295. );
  1296. MetaModel::Init_Params($aParams);
  1297. MetaModel::Init_InheritAttributes();
  1298. MetaModel::Init_AddAttribute(new AttributeExternalKey("sync_source_id", array("targetclass"=>"SynchroDataSource", "jointype"=> "", "allowed_values"=>null, "sql"=>"sync_source_id", "is_null_allowed"=>false, "on_target_delete"=>DEL_SILENT, "depends_on"=>array())));
  1299. MetaModel::Init_AddAttribute(new AttributeExternalField("base_class", array("allowed_values"=>null, "extkey_attcode"=> 'sync_source_id', "target_attcode"=>"scope_class")));
  1300. MetaModel::Init_AddAttribute(new AttributeInteger("dest_id", array("allowed_values"=>null, "sql"=>"dest_id", "default_value"=>0, "is_null_allowed"=>true, "depends_on"=>array())));
  1301. MetaModel::Init_AddAttribute(new AttributeClass("dest_class", array("class_category"=>"", "more_values"=>"", "sql"=>"dest_class", "default_value"=>'Organization', "is_null_allowed"=>true, "depends_on"=>array())));
  1302. MetaModel::Init_AddAttribute(new AttributeDateTime("status_last_seen", array("allowed_values"=>null, "sql"=>"status_last_seen", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
  1303. MetaModel::Init_AddAttribute(new AttributeEnum("status", array("allowed_values"=>new ValueSetEnum('new,synchronized,modified,orphan,obsolete'), "sql"=>"status", "default_value"=>"new", "is_null_allowed"=>false, "depends_on"=>array())));
  1304. MetaModel::Init_AddAttribute(new AttributeBoolean("status_dest_creator", array("allowed_values"=>null, "sql"=>"status_dest_creator", "default_value"=>0, "is_null_allowed"=>true, "depends_on"=>array())));
  1305. MetaModel::Init_AddAttribute(new AttributeString("status_last_error", array("allowed_values"=>null, "sql"=>"status_last_error", "default_value"=>'', "is_null_allowed"=>true, "depends_on"=>array())));
  1306. MetaModel::Init_AddAttribute(new AttributeString("status_last_warning", array("allowed_values"=>null, "sql"=>"status_last_warning", "default_value"=>'', "is_null_allowed"=>true, "depends_on"=>array())));
  1307. MetaModel::Init_AddAttribute(new AttributeDateTime("info_creation_date", array("allowed_values"=>null, "sql"=>"info_creation_date", "default_value"=>"", "is_null_allowed"=>true, "depends_on"=>array())));
  1308. MetaModel::Init_AddAttribute(new AttributeDateTime("info_last_modified", array("allowed_values"=>null, "sql"=>"info_last_modified", "default_value"=>"", "is_null_allowed"=>true, "depends_on"=>array())));
  1309. // Display lists
  1310. MetaModel::Init_SetZListItems('details', array('' .
  1311. 'col:0'=> array(
  1312. 'fieldset:SynchroDataSource:Definition' => array('sync_source_id','dest_id','dest_class'),
  1313. 'fieldset:SynchroDataSource:Status' => array('status','status_last_seen','status_dest_creator','status_last_error','status_last_warning'),
  1314. 'fieldset:SynchroDataSource:Information' => array('info_creation_date','info_last_modified'))
  1315. )
  1316. );
  1317. MetaModel::Init_SetZListItems('list', array('sync_source_id', 'dest_id', 'dest_class', 'status_last_seen', 'status', 'status_dest_creator', 'status_last_error', 'status_last_warning')); // Attributes to be displayed for a list
  1318. // Search criteria
  1319. MetaModel::Init_SetZListItems('standard_search', array('sync_source_id', 'status_last_seen', 'status', 'status_dest_creator', 'dest_class', 'dest_id', 'status_last_error', 'status_last_warning')); // Criteria of the std search form
  1320. // MetaModel::Init_SetZListItems('advanced_search', array('name')); // Criteria of the advanced search form
  1321. }
  1322. public function __construct($aRow = null, $sClassAlias = '', $aAttToLoad = null, $aExtendedDataSpec = null)
  1323. {
  1324. parent::__construct($aRow, $sClassAlias, $aAttToLoad, $aExtendedDataSpec);
  1325. $this->aWarnings = array();
  1326. }
  1327. protected function AddWarning($sWarningMessage)
  1328. {
  1329. $this->aWarnings[] = $sWarningMessage;
  1330. }
  1331. protected function ResetWarnings()
  1332. {
  1333. $this->aWarnings = array();
  1334. }
  1335. protected function HasWarnings()
  1336. {
  1337. return (count($this->aWarnings) > 0);
  1338. }
  1339. protected function RecordWarnings()
  1340. {
  1341. $sWarningMessage = '';
  1342. $MAX_WARNING_LENGTH = 255;
  1343. switch(count($this->aWarnings))
  1344. {
  1345. case 0:
  1346. $sWarningMessage = '';
  1347. break;
  1348. case 1:
  1349. $sWarningMessage = $this->aWarnings[0];
  1350. break;
  1351. default:
  1352. $sWarningMessage = count($this->aWarnings)." warnings: ".implode(' ', $this->aWarnings);
  1353. break;
  1354. }
  1355. if (strlen($sWarningMessage) > $MAX_WARNING_LENGTH)
  1356. {
  1357. $sWarningMessage = substr($sWarningMessage, 0, $MAX_WARNING_LENGTH - 3).'...';
  1358. }
  1359. $this->Set('status_last_warning', $sWarningMessage);
  1360. }
  1361. public function DBInsert()
  1362. {
  1363. throw new CoreException('A synchronization replica must be created only by the mean of triggers');
  1364. }
  1365. // Overload the deletion -> the replica has been created by the mean of a trigger,
  1366. // it will be deleted by the mean of a trigger too
  1367. protected function DBDeleteSingleObject()
  1368. {
  1369. $this->OnDelete();
  1370. if (!MetaModel::DBIsReadOnly())
  1371. {
  1372. $oDataSource = MetaModel::GetObject('SynchroDataSource', $this->Get('sync_source_id'), false);
  1373. if ($oDataSource)
  1374. {
  1375. $sTable = $oDataSource->GetDataTable();
  1376. $sSQL = "DELETE FROM `$sTable` WHERE id = '{$this->GetKey()}'";
  1377. CMDBSource::Query($sSQL);
  1378. }
  1379. // else the whole datasource has probably been already deleted
  1380. }
  1381. $this->AfterDelete();
  1382. $this->m_bIsInDB = false;
  1383. $this->m_iKey = null;
  1384. }
  1385. public function SetLastError($sMessage, $oException = null)
  1386. {
  1387. if ($oException)
  1388. {
  1389. $sText = $sMessage.$oException->getMessage();
  1390. }
  1391. else
  1392. {
  1393. $sText = $sMessage;
  1394. }
  1395. if (strlen($sText) > 255)
  1396. {
  1397. $sText = substr($sText, 0, 200).'...('.strlen($sText).' chars)...';
  1398. }
  1399. $this->Set('status_last_error', $sText);
  1400. }
  1401. public function Synchro($oDataSource, $aReconciliationKeys, $aAttributes, $oChange, &$oStatLog)
  1402. {
  1403. $this->ResetWarnings();
  1404. switch($this->Get('status'))
  1405. {
  1406. case 'new':
  1407. $this->Set('status_dest_creator', false);
  1408. // If needed, construct the query used for the reconciliation
  1409. if (!isset(self::$aSearches[$oDataSource->GetKey()]))
  1410. {
  1411. $aCriterias = array();
  1412. foreach($aReconciliationKeys as $sFilterCode => $oSyncAtt)
  1413. {
  1414. $aCriterias[] = ($sFilterCode == 'primary_key' ? 'id' : $sFilterCode).' = :'.$sFilterCode;
  1415. }
  1416. $sOQL = "SELECT ".$oDataSource->GetTargetClass()." WHERE ".implode(' AND ', $aCriterias);
  1417. self::$aSearches[$oDataSource->GetKey()] = DBObjectSearch::FromOQL($sOQL);
  1418. }
  1419. // Get the criterias for the search
  1420. $aFilterValues = array();
  1421. foreach($aReconciliationKeys as $sFilterCode => $oSyncAtt)
  1422. {
  1423. $value = $this->GetValueFromExtData($sFilterCode, $oSyncAtt, $oStatLog);
  1424. if (!is_null($value))
  1425. {
  1426. $aFilterValues[$sFilterCode] = $value;
  1427. }
  1428. else
  1429. {
  1430. // TO DO: can we retry this ??
  1431. // Reconciliation could not be performed - log and EXIT
  1432. $oStatLog->AddTrace("Could not reconcile on null value for attribute '$sFilterCode'", $this);
  1433. $this->SetLastError("Could not reconcile on null value for attribute '$sFilterCode'");
  1434. $oStatLog->Inc('stats_nb_replica_reconciled_errors');
  1435. return;
  1436. }
  1437. }
  1438. $oDestSet = new DBObjectSet(self::$aSearches[$oDataSource->GetKey()], array(), $aFilterValues);
  1439. $iCount = $oDestSet->Count();
  1440. $aConditions = array();
  1441. foreach($aFilterValues as $sCode => $sValue)
  1442. {
  1443. $aConditions[] = $sCode.'='.$sValue;
  1444. }
  1445. $sConditionDesc = implode(' AND ', $aConditions);
  1446. // How many objects match the reconciliation criterias
  1447. switch($iCount)
  1448. {
  1449. case 0:
  1450. $oStatLog->AddTrace("Nothing found on: $sConditionDesc", $this);
  1451. if ($oDataSource->Get('action_on_zero') == 'create')
  1452. {
  1453. $bCreated = $this->CreateObjectFromReplica($oDataSource->GetTargetClass(), $aAttributes, $oChange, $oStatLog);
  1454. if ($bCreated)
  1455. {
  1456. if ($this->HasWarnings())
  1457. {
  1458. $oStatLog->Inc('stats_nb_obj_created_warnings');
  1459. }
  1460. }
  1461. else
  1462. {
  1463. // Creation error has precedence over any warning
  1464. $this->ResetWarnings();
  1465. }
  1466. }
  1467. else // assumed to be 'error'
  1468. {
  1469. $oStatLog->AddTrace("Failed to reconcile (no match)", $this);
  1470. // Recoverable error
  1471. $this->SetLastError('Could not find a match for reconciliation');
  1472. $oStatLog->Inc('stats_nb_replica_reconciled_errors');
  1473. }
  1474. break;
  1475. case 1:
  1476. $oStatLog->AddTrace("Found 1 object on: $sConditionDesc", $this);
  1477. if ($oDataSource->Get('action_on_one') == 'update')
  1478. {
  1479. $oDestObj = $oDestSet->Fetch();
  1480. $bModified = $this->UpdateObjectFromReplica($oDestObj, $aAttributes, $oChange, $oStatLog, 'stats_nb_obj_new', 'stats_nb_replica_reconciled_errors');
  1481. $this->Set('dest_id', $oDestObj->GetKey());
  1482. $this->Set('dest_class', get_class($oDestObj));
  1483. if ($this->HasWarnings())
  1484. {
  1485. if ($bModified)
  1486. {
  1487. $oStatLog->Inc('stats_nb_obj_new_updated_warnings');
  1488. }
  1489. else
  1490. {
  1491. $oStatLog->Inc('stats_nb_obj_new_unchanged_warnings');
  1492. }
  1493. }
  1494. }
  1495. else
  1496. {
  1497. // assumed to be 'error'
  1498. $oStatLog->AddTrace("Failed to reconcile (1 match)", $this);
  1499. // Recoverable error
  1500. $this->SetLastError('Found a match while expecting several');
  1501. $oStatLog->Inc('stats_nb_replica_reconciled_errors');
  1502. }
  1503. break;
  1504. default:
  1505. $oStatLog->AddTrace("Found $iCount objects on: $sConditionDesc", $this);
  1506. if ($oDataSource->Get('action_on_multiple') == 'error')
  1507. {
  1508. $oStatLog->AddTrace("Failed to reconcile (N>1 matches)", $this);
  1509. // Recoverable error
  1510. $this->SetLastError($iCount.' destination objects match the reconciliation criterias: '.$sConditionDesc);
  1511. $oStatLog->Inc('stats_nb_replica_reconciled_errors');
  1512. }
  1513. elseif ($oDataSource->Get('action_on_multiple') == 'create')
  1514. {
  1515. $bCreated = $this->CreateObjectFromReplica($oDataSource->GetTargetClass(), $aAttributes, $oChange, $oStatLog);
  1516. if ($bCreated)
  1517. {
  1518. if ($this->HasWarnings())
  1519. {
  1520. $oStatLog->Inc('stats_nb_obj_created_warnings');
  1521. }
  1522. }
  1523. else
  1524. {
  1525. // Creation error has precedence over any warning
  1526. $this->ResetWarnings();
  1527. }
  1528. }
  1529. else
  1530. {
  1531. // assumed to be 'take_first'
  1532. $oDestObj = $oDestSet->Fetch();
  1533. $bModified = $this->UpdateObjectFromReplica($oDestObj, $aAttributes, $oChange, $oStatLog, 'stats_nb_obj_new', 'stats_nb_replica_reconciled_errors');
  1534. $this->Set('dest_id', $oDestObj->GetKey());
  1535. $this->Set('dest_class', get_class($oDestObj));
  1536. if ($this->HasWarnings())
  1537. {
  1538. if ($bModified)
  1539. {
  1540. $oStatLog->Inc('stats_nb_obj_new_updated_warnings');
  1541. }
  1542. else
  1543. {
  1544. $oStatLog->Inc('stats_nb_obj_new_unchanged_warnings');
  1545. }
  1546. }
  1547. }
  1548. }
  1549. $this->RecordWarnings();
  1550. break;
  1551. case 'synchronized': // try to recover synchronized replicas with warnings
  1552. case 'modified':
  1553. $oDestObj = MetaModel::GetObject($oDataSource->GetTargetClass(), $this->Get('dest_id'));
  1554. if ($oDestObj == null)
  1555. {
  1556. $this->Set('status', 'orphan'); // The destination object has been deleted !
  1557. $this->SetLastError('Destination object deleted unexpectedly');
  1558. $oStatLog->Inc('stats_nb_obj_updated_errors');
  1559. }
  1560. else
  1561. {
  1562. $bModified = $this->UpdateObjectFromReplica($oDestObj, $aAttributes, $oChange, $oStatLog, 'stats_nb_obj', 'stats_nb_obj_updated_errors');
  1563. if ($this->HasWarnings())
  1564. {
  1565. if ($bModified)
  1566. {
  1567. $oStatLog->Inc('stats_nb_obj_updated_warnings');
  1568. }
  1569. else
  1570. {
  1571. $oStatLog->Inc('stats_nb_obj_unchanged_warnings');
  1572. }
  1573. }
  1574. }
  1575. $this->RecordWarnings();
  1576. break;
  1577. default: // Do nothing in all other cases
  1578. }
  1579. }
  1580. /**
  1581. * Updates the destination object with the Extended data found in the synchro_data_XXXX table
  1582. */
  1583. protected function UpdateObjectFromReplica($oDestObj, $aAttributes, $oChange, &$oStatLog, $sStatsCode, $sStatsCodeError)
  1584. {
  1585. $aValueTrace = array();
  1586. $bModified = false;
  1587. try
  1588. {
  1589. foreach($aAttributes as $sAttCode => $oSyncAtt)
  1590. {
  1591. $value = $this->GetValueFromExtData($sAttCode, $oSyncAtt, $oStatLog);
  1592. if (!is_null($value))
  1593. {
  1594. $oDestObj->Set($sAttCode, $value);
  1595. $aValueTrace[] = "$sAttCode: $value";
  1596. }
  1597. }
  1598. // Really modified ?
  1599. if ($oDestObj->IsModified())
  1600. {
  1601. $oDestObj->DBUpdateTracked($oChange);
  1602. $bModified = true;
  1603. $oStatLog->AddTrace('Updated object - Values: {'.implode(', ', $aValueTrace).'}', $this);
  1604. if (($sStatsCode != '') &&(MetaModel::IsValidAttCode(get_class($oStatLog), $sStatsCode.'_updated')))
  1605. {
  1606. $oStatLog->Inc($sStatsCode.'_updated');
  1607. }
  1608. $this->Set('info_last_modified', date('Y-m-d H:i:s'));
  1609. }
  1610. else
  1611. {
  1612. $oStatLog->AddTrace('Unchanged object', $this);
  1613. if (($sStatsCode != '') &&(MetaModel::IsValidAttCode(get_class($oStatLog), $sStatsCode.'_unchanged')))
  1614. {
  1615. $oStatLog->Inc($sStatsCode.'_unchanged');
  1616. }
  1617. }
  1618. $this->Set('status_last_error', '');
  1619. $this->Set('status', 'synchronized');
  1620. }
  1621. catch(Exception $e)
  1622. {
  1623. $oStatLog->AddTrace("Failed to update destination object: {$e->getMessage()}", $this);
  1624. $this->SetLastError('Unable to update destination object: ', $e);
  1625. $oStatLog->Inc($sStatsCodeError);
  1626. }
  1627. return $bModified;
  1628. }
  1629. /**
  1630. * Creates the destination object populating it with the Extended data found in the synchro_data_XXXX table
  1631. * @return bool Whether or not the object was created
  1632. */
  1633. protected function CreateObjectFromReplica($sClass, $aAttributes, $oChange, &$oStatLog)
  1634. {
  1635. $bCreated = false;
  1636. $oDestObj = MetaModel::NewObject($sClass);
  1637. try
  1638. {
  1639. $aValueTrace = array();
  1640. foreach($aAttributes as $sAttCode => $oSyncAtt)
  1641. {
  1642. $value = $this->GetValueFromExtData($sAttCode, $oSyncAtt, $oStatLog);
  1643. if (!is_null($value))
  1644. {
  1645. $oDestObj->Set($sAttCode, $value);
  1646. $aValueTrace[] = "$sAttCode: $value";
  1647. }
  1648. }
  1649. $iNew = $oDestObj->DBInsertTracked($oChange);
  1650. $this->Set('dest_id', $oDestObj->GetKey());
  1651. $this->Set('dest_class', get_class($oDestObj));
  1652. $this->Set('status_dest_creator', true);
  1653. $this->Set('status_last_error', '');
  1654. $this->Set('status', 'synchronized');
  1655. $this->Set('info_creation_date', date('Y-m-d H:i:s'));
  1656. $bCreated = true;
  1657. $oStatLog->AddTrace("Created (".implode(', ', $aValueTrace).")", $this);
  1658. $oStatLog->Inc('stats_nb_obj_created');
  1659. }
  1660. catch(Exception $e)
  1661. {
  1662. $oStatLog->AddTrace("Failed to create $sClass ({$e->getMessage()})", $this);
  1663. $this->SetLastError('Unable to create destination object: ', $e);
  1664. $oStatLog->Inc('stats_nb_obj_created_errors');
  1665. }
  1666. return $bCreated;
  1667. }
  1668. /**
  1669. * Update the destination object with given values
  1670. */
  1671. public function UpdateDestObject($aValues, $oChange, &$oStatLog)
  1672. {
  1673. try
  1674. {
  1675. if ($this->Get('dest_class') == '')
  1676. {
  1677. $this->SetLastError('No destination object to update');
  1678. $oStatLog->Inc('stats_nb_obj_obsoleted_errors');
  1679. }
  1680. else
  1681. {
  1682. $oDestObj = MetaModel::GetObject($this->Get('dest_class'), $this->Get('dest_id'));
  1683. foreach($aValues as $sAttCode => $value)
  1684. {
  1685. if (!MetaModel::IsValidAttCode(get_class($oDestObj), $sAttCode))
  1686. {
  1687. throw new Exception("Unknown attribute code '$sAttCode'");
  1688. }
  1689. $oDestObj->Set($sAttCode, $value);
  1690. }
  1691. $this->Set('info_last_modified', date('Y-m-d H:i:s'));
  1692. $oDestObj->DBUpdateTracked($oChange);
  1693. $oStatLog->AddTrace("Replica marked as obsolete", $this);
  1694. $oStatLog->Inc('stats_nb_obj_obsoleted');
  1695. }
  1696. }
  1697. catch(Exception $e)
  1698. {
  1699. $this->SetLastError('Unable to update the destination object: ', $e);
  1700. $oStatLog->Inc('stats_nb_obj_obsoleted_errors');
  1701. }
  1702. }
  1703. /**
  1704. * Delete the destination object
  1705. */
  1706. public function DeleteDestObject($oChange, &$oStatLog)
  1707. {
  1708. if($this->Get('status_dest_creator'))
  1709. {
  1710. try
  1711. {
  1712. $oDestObj = MetaModel::GetObject($this->Get('dest_class'), $this->Get('dest_id'));
  1713. $oCheckDeletionPlan = new DeletionPlan();
  1714. if ($oDestObj->CheckToDelete($oCheckDeletionPlan))
  1715. {
  1716. $oActualDeletionPlan = new DeletionPlan();
  1717. $oDestObj->DBDeleteTracked($oChange, null, $oActualDeletionPlan);
  1718. $this->DBDeleteTracked($oChange);
  1719. $oStatLog->Inc('stats_nb_obj_deleted');
  1720. }
  1721. else
  1722. {
  1723. $sIssues = implode("\n", $oCheckDeletionPlan->GetIssues());
  1724. throw(new Exception($sIssues));
  1725. }
  1726. }
  1727. catch(Exception $e)
  1728. {
  1729. $this->SetLastError('Unable to delete the destination object: ', $e);
  1730. $this->Set('status', 'obsolete');
  1731. $this->DBUpdateTracked($oChange);
  1732. $oStatLog->Inc('stats_nb_obj_deleted_errors');
  1733. }
  1734. }
  1735. else
  1736. {
  1737. $this->DBDeleteTracked($oChange);
  1738. $oStatLog->Inc('stats_nb_replica_disappeared_no_action');
  1739. }
  1740. }
  1741. /**
  1742. * Get the value from the 'Extended Data' located in the synchro_data_xxx table for this replica
  1743. * Note: sExtAttCode could be a standard attcode, or 'primary_key'
  1744. */
  1745. protected function GetValueFromExtData($sExtAttCode, $oSyncAtt, &$oStatLog)
  1746. {
  1747. // $aData should contain attributes defined either for reconciliation or create/update
  1748. $aData = $this->GetExtendedData();
  1749. if ($sExtAttCode == 'primary_key')
  1750. {
  1751. return $aData['primary_key'];
  1752. }
  1753. // $sExtAttCode is a valid attribute code
  1754. //
  1755. $sClass = $this->Get('base_class');
  1756. $oAttDef = MetaModel::GetAttributeDef($sClass, $sExtAttCode);
  1757. if (!is_null($oSyncAtt) && ($oSyncAtt instanceof SynchroAttExtKey))
  1758. {
  1759. $rawValue = $aData[$sExtAttCode];
  1760. if (is_null($rawValue))
  1761. {
  1762. // Null means "ignore" this attribute
  1763. return null;
  1764. }
  1765. $sReconcAttCode = $oSyncAtt->Get('reconciliation_attcode');
  1766. if (!empty($sReconcAttCode))
  1767. {
  1768. $sRemoteClass = $oAttDef->GetTargetClass();
  1769. $oObj = MetaModel::GetObjectByColumn($sRemoteClass, $sReconcAttCode, $rawValue, false);
  1770. if ($oObj)
  1771. {
  1772. $retValue = $oObj->GetKey();
  1773. }
  1774. else
  1775. {
  1776. if ($rawValue != '')
  1777. {
  1778. // Note: differs from null (in which case the value would be left unchanged)
  1779. $oStatLog->AddTrace("Could not find [unique] object for '$sExtAttCode': searched on $sReconcAttCode = '$rawValue'", $this);
  1780. $this->AddWarning("Could not find [unique] object for '$sExtAttCode': searched on $sReconcAttCode = '$rawValue'");
  1781. }
  1782. $retValue = 0;
  1783. }
  1784. }
  1785. else
  1786. {
  1787. $retValue = $rawValue;
  1788. }
  1789. }
  1790. elseif (!is_null($oSyncAtt) && ($oSyncAtt instanceof SynchroAttLinkSet))
  1791. {
  1792. $rawValue = $aData[$sExtAttCode];
  1793. if (is_null($rawValue))
  1794. {
  1795. // Null means "ignore" this attribute
  1796. return null;
  1797. }
  1798. // MakeValueFromString() throws an exception in case of failure
  1799. $retValue = $oAttDef->MakeValueFromString($rawValue, $oSyncAtt->Get('row_separator'), $oSyncAtt->Get('attribute_separator'), $oSyncAtt->Get('value_separator'), $oSyncAtt->Get('attribute_qualifier'));
  1800. }
  1801. else
  1802. {
  1803. $aColumns = $oAttDef->GetImportColumns();
  1804. foreach($aColumns as $sColumn => $sFormat)
  1805. {
  1806. // In any case, a null column means "ignore this attribute"
  1807. //
  1808. if (is_null($aData[$sColumn]))
  1809. {
  1810. return null;
  1811. }
  1812. }
  1813. $retValue = $oAttDef->FromImportToValue($aData, $sExtAttCode);
  1814. }
  1815. return $retValue;
  1816. }
  1817. /**
  1818. * Maps the given context parameter name to the appropriate filter/search code for this class
  1819. * @param string $sContextParam Name of the context parameter, i.e. 'org_id'
  1820. * @return string Filter code, i.e. 'customer_id'
  1821. */
  1822. public static function MapContextParam($sContextParam)
  1823. {
  1824. if ($sContextParam == 'menu')
  1825. {
  1826. return null;
  1827. }
  1828. else
  1829. {
  1830. return $sContextParam;
  1831. }
  1832. }
  1833. /**
  1834. * This function returns a 'hilight' CSS class, used to hilight a given row in a table
  1835. * There are currently (i.e defined in the CSS) 4 possible values HILIGHT_CLASS_CRITICAL,
  1836. * HILIGHT_CLASS_WARNING, HILIGHT_CLASS_OK, HILIGHT_CLASS_NONE
  1837. * To Be overridden by derived classes
  1838. * @param void
  1839. * @return String The desired higlight class for the object/row
  1840. */
  1841. public function GetHilightClass()
  1842. {
  1843. // Possible return values are:
  1844. // HILIGHT_CLASS_CRITICAL, HILIGHT_CLASS_WARNING, HILIGHT_CLASS_OK, HILIGHT_CLASS_NONE
  1845. return HILIGHT_CLASS_NONE; // Not hilighted by default
  1846. }
  1847. public static function GetUIPage()
  1848. {
  1849. return '../synchro/replica.php';
  1850. }
  1851. function DisplayDetails(WebPage $oPage, $bEditMode = false)
  1852. {
  1853. // Object's details
  1854. //$this->DisplayBareHeader($oPage, $bEditMode);
  1855. $oPage->AddTabContainer(OBJECT_PROPERTIES_TAB);
  1856. $oPage->SetCurrentTabContainer(OBJECT_PROPERTIES_TAB);
  1857. $oPage->SetCurrentTab(Dict::S('UI:PropertiesTab'));
  1858. $this->DisplayBareProperties($oPage, $bEditMode);
  1859. }
  1860. function DisplayBareProperties(WebPage $oPage, $bEditMode = false, $sPrefix = '', $aExtraParams = array())
  1861. {
  1862. if ($bEditMode) return; // Not editable
  1863. $oPage->add('<table style="vertical-align:top"><tr style="vertical-align:top"><td>');
  1864. $aDetails = array();
  1865. $sClass = get_class($this);
  1866. $oPage->add('<fieldset>');
  1867. $oPage->add('<legend>'.Dict::S('Core:SynchroReplica:PrivateDetails').'</legend>');
  1868. $aZList = MetaModel::FlattenZlist(MetaModel::GetZListItems($sClass, 'details'));
  1869. foreach( $aZList as $sAttCode)
  1870. {
  1871. $sDisplayValue = $this->GetAsHTML($sAttCode);
  1872. $aDetails[] = array('label' => '<span title="'.MetaModel::GetDescription($sClass, $sAttCode).'">'.MetaModel::GetLabel($sClass, $sAttCode).'</span>', 'value' => $sDisplayValue);
  1873. }
  1874. $oPage->Details($aDetails);
  1875. $oPage->add('</fieldset>');
  1876. if (strlen($this->Get('dest_class')) > 0)
  1877. {
  1878. $oDestObj = MetaModel::GetObject($this->Get('dest_class'), $this->Get('dest_id'), false);
  1879. if (is_object($oDestObj))
  1880. {
  1881. $oPage->add('<fieldset>');
  1882. $oPage->add('<legend>'.Dict::Format('Core:SynchroReplica:TargetObject', $oDestObj->GetHyperlink()).'</legend>');
  1883. $oDestObj->DisplayBareProperties($oPage, false, $sPrefix, $aExtraParams);
  1884. $oPage->add('<fieldset>');
  1885. }
  1886. }
  1887. $oPage->add('</td><td>');
  1888. $oPage->add('<fieldset>');
  1889. $oPage->add('<legend>'.Dict::S('Core:SynchroReplica:PublicData').'</legend>');
  1890. $oSource = MetaModel::GetObject('SynchroDataSource', $this->Get('sync_source_id'));
  1891. $sSQLTable = $oSource->GetDataTable();
  1892. $aData = $this->LoadExtendedDataFromTable($sSQLTable);
  1893. $aHeaders = array('attcode' => array('label' => 'Attribute Code', 'description' => ''),
  1894. 'data' => array('label' => 'Value', 'description' => ''));
  1895. $aRows = array();
  1896. foreach($aData as $sKey => $value)
  1897. {
  1898. $aRows[] = array('attcode' => $sKey, 'data' => $value);
  1899. }
  1900. $oPage->Table($aHeaders, $aRows);
  1901. $oPage->add('</fieldset>');
  1902. $oPage->add('</td></tr></table>');
  1903. }
  1904. public function LoadExtendedDataFromTable($sSQLTable)
  1905. {
  1906. $sSQL = "SELECT * FROM $sSQLTable WHERE id=".$this->GetKey();
  1907. $rQuery = CMDBSource::Query($sSQL);
  1908. return CMDBSource::FetchArray($rQuery);
  1909. }
  1910. }
  1911. /**
  1912. * Context of an ongoing synchronization
  1913. * Two usages:
  1914. * 1) Public usage: execute the synchronization
  1915. * $oSynchroExec = new SynchroExecution($oDataSource[, $iLastFullLoad]);
  1916. * $oSynchroExec->Process($iMaxChunkSize);
  1917. *
  1918. * 2) Internal usage: continue the synchronization (split into chunks, each performed in a separate process)
  1919. * This is implemented in the page priv_sync_chunk.php
  1920. * $oSynchroExec = SynchroExecution::Resume($oDataSource, $iLastFullLoad, $iSynchroLog, $iChange, $iMaxToProcess, $iJob, $iNextInJob);
  1921. * $oSynchroExec->Process()
  1922. */
  1923. class SynchroExecution
  1924. {
  1925. protected $m_oDataSource = null;
  1926. protected $m_oLastFullLoadStartDate = null;
  1927. protected $m_oChange = null;
  1928. protected $m_oStatLog = null;
  1929. // Context computed one for optimization and report inconsistencies ASAP
  1930. protected $m_aExtDataSpec = array();
  1931. protected $m_aReconciliationKeys = array();
  1932. protected $m_aAttributes = array();
  1933. protected $m_iCountAllReplicas = 0;
  1934. /**
  1935. * Constructor
  1936. * @param SynchroDataSource $oDataSource Synchronization task
  1937. * @param DateTime $oLastFullLoadStartDate Date of the last full load (start date/time), if known
  1938. * @return void
  1939. */
  1940. public function __construct($oDataSource, $oLastFullLoadStartDate = null)
  1941. {
  1942. $this->m_oDataSource = $oDataSource;
  1943. $this->m_oLastFullLoadStartDate = $oLastFullLoadStartDate;
  1944. }
  1945. /**
  1946. * Create the persistant information records, for the current synchronization
  1947. * In fact, those records ARE defining what is the "current" synchronization
  1948. */
  1949. protected function PrepareLogs()
  1950. {
  1951. if (!is_null($this->m_oChange))
  1952. {
  1953. return;
  1954. }
  1955. // Create a change used for logging all the modifications/creations happening during the synchro
  1956. $this->m_oChange = MetaModel::NewObject("CMDBChange");
  1957. $this->m_oChange->Set("date", time());
  1958. $sUserString = CMDBChange::GetCurrentUserName();
  1959. $this->m_oChange->Set("userinfo", $sUserString.' '.Dict::S('Core:SyncDataExchangeComment'));
  1960. $iChangeId = $this->m_oChange->DBInsert();
  1961. // Start logging this execution (stats + protection against reentrance)
  1962. //
  1963. $this->m_oStatLog = new SynchroLog();
  1964. $this->m_oStatLog->Set('sync_source_id', $this->m_oDataSource->GetKey());
  1965. $this->m_oStatLog->Set('start_date', time());
  1966. $this->m_oStatLog->Set('status', 'running');
  1967. $this->m_oStatLog->Set('stats_nb_replica_seen', 0);
  1968. $this->m_oStatLog->Set('stats_nb_replica_total', 0);
  1969. $this->m_oStatLog->Set('stats_nb_obj_deleted', 0);
  1970. $this->m_oStatLog->Set('stats_nb_obj_deleted_errors', 0);
  1971. $this->m_oStatLog->Set('stats_nb_obj_obsoleted', 0);
  1972. $this->m_oStatLog->Set('stats_nb_obj_obsoleted_errors', 0);
  1973. $this->m_oStatLog->Set('stats_nb_obj_created', 0);
  1974. $this->m_oStatLog->Set('stats_nb_obj_created_errors', 0);
  1975. $this->m_oStatLog->Set('stats_nb_obj_created_warnings', 0);
  1976. $this->m_oStatLog->Set('stats_nb_obj_updated', 0);
  1977. $this->m_oStatLog->Set('stats_nb_obj_updated_warnings', 0);
  1978. $this->m_oStatLog->Set('stats_nb_obj_updated_errors', 0);
  1979. $this->m_oStatLog->Set('stats_nb_obj_unchanged_warnings', 0);
  1980. // $this->m_oStatLog->Set('stats_nb_replica_reconciled', 0);
  1981. $this->m_oStatLog->Set('stats_nb_replica_reconciled_errors', 0);
  1982. $this->m_oStatLog->Set('stats_nb_replica_disappeared_no_action', 0);
  1983. $this->m_oStatLog->Set('stats_nb_obj_new_updated', 0);
  1984. $this->m_oStatLog->Set('stats_nb_obj_new_updated_warnings', 0);
  1985. $this->m_oStatLog->Set('stats_nb_obj_new_unchanged',0);
  1986. $this->m_oStatLog->Set('stats_nb_obj_new_unchanged_warnings',0);
  1987. $sSelectTotal = "SELECT SynchroReplica WHERE sync_source_id = :source_id";
  1988. $oSetTotal = new DBObjectSet(DBObjectSearch::FromOQL($sSelectTotal), array() /* order by*/, array('source_id' => $this->m_oDataSource->GetKey()));
  1989. $this->m_iCountAllReplicas = $oSetTotal->Count();
  1990. $this->m_oStatLog->Set('stats_nb_replica_total', $this->m_iCountAllReplicas);
  1991. $this->m_oStatLog->DBInsertTracked($this->m_oChange);
  1992. }
  1993. /**
  1994. * Prevent against the reentrance... or allow the current task to do things forbidden by the others !
  1995. */
  1996. public static $m_oCurrentTask = null;
  1997. public static function GetCurrentTaskId()
  1998. {
  1999. if (is_object(self::$m_oCurrentTask))
  2000. {
  2001. return self::$m_oCurrentTask->GetKey();
  2002. }
  2003. else
  2004. {
  2005. return null;
  2006. }
  2007. }
  2008. /**
  2009. * Prepare structures in memory, to speedup the processing of a given replica
  2010. */
  2011. public function PrepareProcessing($bFirstPass = true)
  2012. {
  2013. if ($this->m_oDataSource->Get('status') == 'obsolete')
  2014. {
  2015. throw new SynchroExceptionNotStarted(Dict::S('Core:SyncDataSourceObsolete'));
  2016. }
  2017. if (!UserRights::IsAdministrator() && $this->m_oDataSource->Get('user_id') != UserRights::GetUserId())
  2018. {
  2019. throw new SynchroExceptionNotStarted(Dict::S('Core:SyncDataSourceAccessRestriction'));
  2020. }
  2021. // Get the list of SQL columns
  2022. $sClass = $this->m_oDataSource->GetTargetClass();
  2023. $aAttCodesExpected = array();
  2024. $aAttCodesToReconcile = array();
  2025. $aAttCodesToUpdate = array();
  2026. $sSelectAtt = "SELECT SynchroAttribute WHERE sync_source_id = :source_id AND (update = 1 OR reconcile = 1)";
  2027. $oSetAtt = new DBObjectSet(DBObjectSearch::FromOQL($sSelectAtt), array() /* order by*/, array('source_id' => $this->m_oDataSource->GetKey()) /* aArgs */);
  2028. while ($oSyncAtt = $oSetAtt->Fetch())
  2029. {
  2030. if ($oSyncAtt->Get('update'))
  2031. {
  2032. $aAttCodesToUpdate[$oSyncAtt->Get('attcode')] = $oSyncAtt;
  2033. }
  2034. if ($oSyncAtt->Get('reconcile'))
  2035. {
  2036. $aAttCodesToReconcile[$oSyncAtt->Get('attcode')] = $oSyncAtt;
  2037. }
  2038. $aAttCodesExpected[$oSyncAtt->Get('attcode')] = $oSyncAtt;
  2039. }
  2040. $aColumns = $this->m_oDataSource->GetSQLColumns(array_keys($aAttCodesExpected));
  2041. $aExtDataFields = array_keys($aColumns);
  2042. $aExtDataFields[] = 'primary_key';
  2043. $this->m_aExtDataSpec = array(
  2044. 'table' => $this->m_oDataSource->GetDataTable(),
  2045. 'join_key' => 'id',
  2046. 'fields' => $aExtDataFields
  2047. );
  2048. // Get the list of attributes, determine reconciliation keys and update targets
  2049. //
  2050. if ($this->m_oDataSource->Get('reconciliation_policy') == 'use_attributes')
  2051. {
  2052. $this->m_aReconciliationKeys = $aAttCodesToReconcile;
  2053. }
  2054. elseif ($this->m_oDataSource->Get('reconciliation_policy') == 'use_primary_key')
  2055. {
  2056. // Override the settings made at the attribute level !
  2057. $this->m_aReconciliationKeys = array("primary_key" => null);
  2058. }
  2059. if ($bFirstPass)
  2060. {
  2061. $this->m_oStatLog->AddTrace("Update of: {".implode(', ', array_keys($aAttCodesToUpdate))."}");
  2062. $this->m_oStatLog->AddTrace("Reconciliation on: {".implode(', ', array_keys($this->m_aReconciliationKeys))."}");
  2063. }
  2064. if (count($aAttCodesToUpdate) == 0)
  2065. {
  2066. $this->m_oStatLog->AddTrace("No attribute to update");
  2067. throw new SynchroExceptionNotStarted('There is no attribute to update');
  2068. }
  2069. if (count($this->m_aReconciliationKeys) == 0)
  2070. {
  2071. $this->m_oStatLog->AddTrace("No attribute for reconciliation");
  2072. throw new SynchroExceptionNotStarted('No attribute for reconciliation');
  2073. }
  2074. $this->m_aAttributes = array();
  2075. foreach($aAttCodesToUpdate as $sAttCode => $oSyncAtt)
  2076. {
  2077. $oAttDef = MetaModel::GetAttributeDef($this->m_oDataSource->GetTargetClass(), $sAttCode);
  2078. if ($oAttDef->IsWritable())
  2079. {
  2080. $this->m_aAttributes[$sAttCode] = $oSyncAtt;
  2081. }
  2082. }
  2083. // Compute and keep track of the limit date taken into account for obsoleting replicas
  2084. //
  2085. if ($this->m_oLastFullLoadStartDate == null)
  2086. {
  2087. // No previous import known, use the full_load_periodicity value... and the current date
  2088. $this->m_oLastFullLoadStartDate = new DateTime(); // Now
  2089. $iLoadPeriodicity = $this->m_oDataSource->Get('full_load_periodicity'); // Duration in seconds
  2090. if ($iLoadPeriodicity > 0)
  2091. {
  2092. $sInterval = "-$iLoadPeriodicity seconds";
  2093. $this->m_oLastFullLoadStartDate->Modify($sInterval);
  2094. }
  2095. else
  2096. {
  2097. $this->m_oLastFullLoadStartDate = new DateTime('1970-01-01');
  2098. }
  2099. }
  2100. if ($bFirstPass)
  2101. {
  2102. $this->m_oStatLog->AddTrace("Limit Date: ".$this->m_oLastFullLoadStartDate->Format('Y-m-d H:i:s'));
  2103. }
  2104. }
  2105. /**
  2106. * Perform a synchronization between the data stored in the replicas (&synchro_data_xxx_xx table)
  2107. * and the iTop objects. If the lastFullLoadStartDate is NOT specified then the full_load_periodicity
  2108. * is used to determine which records are obsolete.
  2109. * @return void
  2110. */
  2111. public function Process()
  2112. {
  2113. $this->PrepareLogs();
  2114. self::$m_oCurrentTask = $this->m_oDataSource;
  2115. try
  2116. {
  2117. $this->DoSynchronize();
  2118. $this->m_oStatLog->Set('end_date', time());
  2119. $this->m_oStatLog->Set('status', 'completed');
  2120. $this->m_oStatLog->DBUpdateTracked($this->m_oChange);
  2121. $iErrors = $this->m_oStatLog->GetErrorCount();
  2122. if ($iErrors > 0)
  2123. {
  2124. $sIssuesOQL = "SELECT SynchroReplica WHERE sync_source_id=".$this->m_oDataSource->GetKey()." AND status_last_error!=''";
  2125. $sAbsoluteUrl = utils::GetAbsoluteUrlAppRoot();
  2126. $sIssuesURL = "{$sAbsoluteUrl}synchro/replica.php?operation=oql&datasource=".$this->m_oDataSource->GetKey()."&oql=".urlencode($sIssuesOQL);
  2127. $sSeeIssues = "<p></p>";
  2128. $sStatistics = "<h1>Statistics</h1>\n";
  2129. $sStatistics .= "<ul>\n";
  2130. $sStatistics .= "<li>".$this->m_oStatLog->GetLabel('start_date').": ".$this->m_oStatLog->Get('start_date')."</li>\n";
  2131. $sStatistics .= "<li>".$this->m_oStatLog->GetLabel('end_date').": ".$this->m_oStatLog->Get('end_date')."</li>\n";
  2132. $sStatistics .= "<li>".$this->m_oStatLog->GetLabel('stats_nb_replica_seen').": ".$this->m_oStatLog->Get('stats_nb_replica_seen')."</li>\n";
  2133. $sStatistics .= "<li>".$this->m_oStatLog->GetLabel('stats_nb_replica_total').": ".$this->m_oStatLog->Get('stats_nb_replica_total')."</li>\n";
  2134. $sStatistics .= "<li>".$this->m_oStatLog->GetLabel('stats_nb_obj_deleted').": ".$this->m_oStatLog->Get('stats_nb_obj_deleted')."</li>\n";
  2135. $sStatistics .= "<li>".$this->m_oStatLog->GetLabel('stats_nb_obj_deleted_errors').": ".$this->m_oStatLog->Get('stats_nb_obj_deleted_errors')."</li>\n";
  2136. $sStatistics .= "<li>".$this->m_oStatLog->GetLabel('stats_nb_obj_obsoleted').": ".$this->m_oStatLog->Get('stats_nb_obj_obsoleted')."</li>\n";
  2137. $sStatistics .= "<li>".$this->m_oStatLog->GetLabel('stats_nb_obj_obsoleted_errors').": ".$this->m_oStatLog->Get('stats_nb_obj_obsoleted_errors')."</li>\n";
  2138. $sStatistics .= "<li>".$this->m_oStatLog->GetLabel('stats_nb_obj_created').": ".$this->m_oStatLog->Get('stats_nb_obj_created')." (".$this->m_oStatLog->Get('stats_nb_obj_created_warnings')." warnings)"."</li>\n";
  2139. $sStatistics .= "<li>".$this->m_oStatLog->GetLabel('stats_nb_obj_created_errors').": ".$this->m_oStatLog->Get('stats_nb_obj_created_errors')."</li>\n";
  2140. $sStatistics .= "<li>".$this->m_oStatLog->GetLabel('stats_nb_obj_updated').": ".$this->m_oStatLog->Get('stats_nb_obj_updated')." (".$this->m_oStatLog->Get('stats_nb_obj_updated_warnings')." warnings)"."</li>\n";
  2141. $sStatistics .= "<li>".$this->m_oStatLog->GetLabel('stats_nb_obj_updated_errors').": ".$this->m_oStatLog->Get('stats_nb_obj_updated_errors')."</li>\n";
  2142. $sStatistics .= "<li>".$this->m_oStatLog->GetLabel('stats_nb_replica_reconciled_errors').": ".$this->m_oStatLog->Get('stats_nb_replica_reconciled_errors')."</li>\n";
  2143. $sStatistics .= "<li>".$this->m_oStatLog->GetLabel('stats_nb_replica_disappeared_no_action').": ".$this->m_oStatLog->Get('stats_nb_replica_disappeared_no_action')."</li>\n";
  2144. $sStatistics .= "<li>".$this->m_oStatLog->GetLabel('stats_nb_obj_new_updated').": ".$this->m_oStatLog->Get('stats_nb_obj_new_updated')." (".$this->m_oStatLog->Get('stats_nb_obj_new_updated_warnings')." warnings)"."</li>\n";
  2145. $sStatistics .= "<li>".$this->m_oStatLog->GetLabel('stats_nb_obj_new_unchanged').": ".$this->m_oStatLog->Get('stats_nb_obj_new_unchanged')." (".$this->m_oStatLog->Get('stats_nb_obj_new_unchanged_warnings')." warnings)"."</li>\n";
  2146. $sStatistics .= "</ul>\n";
  2147. $this->m_oDataSource->SendNotification("errors ($iErrors)", "<p>The synchronization has been executed, $iErrors errors have been encountered. Click <a href=\"$sIssuesURL\">here</a> to see the records being currently in error.</p>".$sStatistics);
  2148. }
  2149. else
  2150. {
  2151. //$this->m_oDataSource->SendNotification('success', '<p>The synchronization has been successfully executed.</p>');
  2152. }
  2153. }
  2154. catch (SynchroExceptionNotStarted $e)
  2155. {
  2156. // Set information for reporting... but delete the object in DB
  2157. $this->m_oStatLog->Set('end_date', time());
  2158. $this->m_oStatLog->Set('status', 'error');
  2159. $this->m_oStatLog->Set('last_error', $e->getMessage());
  2160. $this->m_oStatLog->DBDeleteTracked($this->m_oChange);
  2161. $this->m_oDataSource->SendNotification('fatal error', '<p>The synchronization could not start: \''.$e->getMessage().'\'</p><p>Please check its configuration</p>');
  2162. }
  2163. catch (Exception $e)
  2164. {
  2165. $this->m_oStatLog->Set('end_date', time());
  2166. $this->m_oStatLog->Set('status', 'error');
  2167. $this->m_oStatLog->Set('last_error', $e->getMessage());
  2168. $this->m_oStatLog->DBUpdateTracked($this->m_oChange);
  2169. $this->m_oDataSource->SendNotification('exception', '<p>The synchronization has been interrupted: \''.$e->getMessage().'\'</p><p>Please contact the application support team</p>');
  2170. }
  2171. self::$m_oCurrentTask = null;
  2172. return $this->m_oStatLog;
  2173. }
  2174. /**
  2175. * Do the entire synchronization job
  2176. */
  2177. protected function DoSynchronize()
  2178. {
  2179. $this->m_oStatLog->Set('status_curr_job', 1);
  2180. $this->m_oStatLog->Set('status_curr_pos', -1);
  2181. $iMaxChunkSize = utils::ReadParam('max_chunk_size', 0, true /* allow CLI */);
  2182. if ($iMaxChunkSize > 0)
  2183. {
  2184. // Split the execution into several processes
  2185. // Each process will call DoSynchronizeChunk()
  2186. // The loop will end when a process does not reply "continue" on the last line of its output
  2187. if (!utils::IsModeCLI())
  2188. {
  2189. throw new SynchroExceptionNotStarted(Dict::S('Core:SyncSplitModeCLIOnly'));
  2190. }
  2191. $aArguments = array();
  2192. $aArguments['source'] = $this->m_oDataSource->GetKey();
  2193. $aArguments['log'] = $this->m_oStatLog->GetKey();
  2194. $aArguments['change'] = $this->m_oChange->GetKey();
  2195. $aArguments['chunk'] = $iMaxChunkSize;
  2196. if ($this->m_oLastFullLoadStartDate)
  2197. {
  2198. $aArguments['last_full_load'] = $this->m_oLastFullLoadStartDate->Format('Y-m-d H:i:s');
  2199. }
  2200. else
  2201. {
  2202. $aArguments['last_full_load'] = '';
  2203. }
  2204. $this->m_oStatLog->DBUpdate($this->m_oChange);
  2205. $iStepCount = 0;
  2206. do
  2207. {
  2208. $aArguments['step_count'] = $iStepCount;
  2209. $iStepCount++;
  2210. list ($iRes, $aOut) = utils::ExecITopScript('synchro/priv_sync_chunk.php', $aArguments);
  2211. // Reload the log that has been modified by the processes
  2212. $this->m_oStatLog->Reload();
  2213. $sLastRes = strtolower(trim(end($aOut)));
  2214. switch($sLastRes)
  2215. {
  2216. case 'continue':
  2217. $bContinue = true;
  2218. break;
  2219. case 'finished':
  2220. $bContinue = false;
  2221. break;
  2222. default:
  2223. $this->m_oStatLog->AddTrace("The script did not reply with the expected keywords:");
  2224. $aIndentedOut = array();
  2225. foreach ($aOut as $sOut)
  2226. {
  2227. $aIndentedOut[] = "-> $sOut";
  2228. $this->m_oStatLog->AddTrace(">>> $sOut");
  2229. }
  2230. throw new Exception("Encountered an error in an underspinned process:\n".implode("\n", $aIndentedOut));
  2231. }
  2232. }
  2233. while ($bContinue);
  2234. }
  2235. else
  2236. {
  2237. $this->PrepareProcessing(/* first pass */);
  2238. $this->DoJob1();
  2239. $this->DoJob2();
  2240. $this->DoJob3();
  2241. }
  2242. }
  2243. /**
  2244. * Do the synchronization job, limited to some amount of work
  2245. * This verb has been designed to be called from within a separate process
  2246. * @return true if the process has to be continued
  2247. */
  2248. public function DoSynchronizeChunk($oLog, $oChange, $iMaxChunkSize)
  2249. {
  2250. // Initialize the structures...
  2251. self::$m_oCurrentTask = $this->m_oDataSource;
  2252. $this->m_oStatLog = $oLog;
  2253. $this->m_oChange = $oChange;
  2254. // Prepare internal structures (not the first pass)
  2255. $this->PrepareProcessing(false);
  2256. $iCurrJob = $this->m_oStatLog->Get('status_curr_job');
  2257. $iCurrPos = $this->m_oStatLog->Get('status_curr_pos');
  2258. $this->m_oStatLog->AddTrace("Synchronizing chunk - curr_job:$iCurrJob, curr_pos:$iCurrPos, max_chunk_size:$iMaxChunkSize");
  2259. $bContinue = false;
  2260. switch ($iCurrJob)
  2261. {
  2262. case 1:
  2263. default:
  2264. $this->DoJob1($iMaxChunkSize, $iCurrPos);
  2265. $bContinue = true;
  2266. break;
  2267. case 2:
  2268. $this->DoJob2($iMaxChunkSize, $iCurrPos);
  2269. $bContinue = true;
  2270. break;
  2271. case 3:
  2272. $bContinue = $this->DoJob3($iMaxChunkSize, $iCurrPos);
  2273. break;
  2274. }
  2275. $this->m_oStatLog->DBUpdate($this->m_oChange);
  2276. self::$m_oCurrentTask = null;
  2277. return $bContinue;
  2278. }
  2279. /**
  2280. * Do the synchronization job #1: Obsolete replica "untouched" for some time
  2281. * @param integer $iMaxReplica Limit the number of replicas to process
  2282. * @param integer $iCurrPos Current position where to resume the processing
  2283. * @return true if the process must be continued
  2284. */
  2285. protected function DoJob1($iMaxReplica = null, $iCurrPos = -1)
  2286. {
  2287. $sLimitDate = $this->m_oLastFullLoadStartDate->Format('Y-m-d H:i:s');
  2288. // Get all the replicas that were not seen in the last import and mark them as obsolete
  2289. $sDeletePolicy = $this->m_oDataSource->Get('delete_policy');
  2290. if ($sDeletePolicy != 'ignore')
  2291. {
  2292. $sSelectToObsolete = "SELECT SynchroReplica WHERE id > :curr_pos AND sync_source_id = :source_id AND status IN ('new', 'synchronized', 'modified', 'orphan') AND status_last_seen < :last_import";
  2293. $oSetScope = new DBObjectSet(DBObjectSearch::FromOQL($sSelectToObsolete), array() /* order by*/, array('source_id' => $this->m_oDataSource->GetKey(), 'last_import' => $sLimitDate, 'curr_pos' => $iCurrPos));
  2294. $iCountScope = $oSetScope->Count();
  2295. if (($this->m_iCountAllReplicas > 10) && ($this->m_iCountAllReplicas == $iCountScope))
  2296. {
  2297. throw new SynchroExceptionNotStarted(Dict::S('Core:SyncTooManyMissingReplicas'));
  2298. }
  2299. if ($iMaxReplica)
  2300. {
  2301. // Consider a given subset, starting from replica iCurrPos, limited to the count of iMaxReplica
  2302. // The replica have to be ordered by id
  2303. $oSetToProcess = new DBObjectSet(DBObjectSearch::FromOQL($sSelectToObsolete), array('id'=>true) /* order by*/, array('source_id' => $this->m_oDataSource->GetKey(), 'last_import' => $sLimitDate, 'curr_pos' => $iCurrPos));
  2304. $oSetToProcess->SetLimit($iMaxReplica);
  2305. }
  2306. else
  2307. {
  2308. $oSetToProcess = $oSetScope;
  2309. }
  2310. $iLastReplicaProcessed = -1;
  2311. while($oReplica = $oSetToProcess->Fetch())
  2312. {
  2313. $iLastReplicaProcessed = $oReplica->GetKey();
  2314. switch ($sDeletePolicy)
  2315. {
  2316. case 'update':
  2317. case 'update_then_delete':
  2318. $this->m_oStatLog->AddTrace("Destination object to be updated", $oReplica);
  2319. $aToUpdate = array();
  2320. $aToUpdateSpec = explode(';', $this->m_oDataSource->Get('delete_policy_update')); //ex: 'status:obsolete;description:stopped',
  2321. foreach($aToUpdateSpec as $sUpdateSpec)
  2322. {
  2323. $aUpdateSpec = explode(':', $sUpdateSpec);
  2324. if (count($aUpdateSpec) == 2)
  2325. {
  2326. $sAttCode = $aUpdateSpec[0];
  2327. $sValue = $aUpdateSpec[1];
  2328. $aToUpdate[$sAttCode] = $sValue;
  2329. }
  2330. }
  2331. $oReplica->Set('status_last_error', '');
  2332. if ($oReplica->Get('dest_id') == '')
  2333. {
  2334. $oReplica->Set('status', 'obsolete');
  2335. $this->m_oStatLog->Inc('stats_nb_replica_disappeared_no_action');
  2336. }
  2337. else
  2338. {
  2339. $oReplica->UpdateDestObject($aToUpdate, $this->m_oChange, $this->m_oStatLog);
  2340. if ($oReplica->Get('status_last_error') == '')
  2341. {
  2342. // Change the status of the replica IIF
  2343. $oReplica->Set('status', 'obsolete');
  2344. }
  2345. }
  2346. $oReplica->DBUpdateTracked($this->m_oChange);
  2347. break;
  2348. case 'delete':
  2349. default:
  2350. $this->m_oStatLog->AddTrace("Destination object to be DELETED", $oReplica);
  2351. $oReplica->DeleteDestObject($this->m_oChange, $this->m_oStatLog);
  2352. }
  2353. }
  2354. if ($iMaxReplica)
  2355. {
  2356. if ($iMaxReplica < $iCountScope)
  2357. {
  2358. // Continue with this job!
  2359. $this->m_oStatLog->Set('status_curr_pos', $iLastReplicaProcessed);
  2360. return true;
  2361. }
  2362. }
  2363. } // if ($sDeletePolicy != 'ignore'
  2364. //Count "seen" objects
  2365. $sSelectSeen = "SELECT SynchroReplica WHERE sync_source_id = :source_id AND status IN ('new', 'synchronized', 'modified', 'orphan') AND status_last_seen >= :last_import";
  2366. $oSetSeen = new DBObjectSet(DBObjectSearch::FromOQL($sSelectSeen), array() /* order by*/, array('source_id' => $this->m_oDataSource->GetKey(), 'last_import' => $sLimitDate));
  2367. $this->m_oStatLog->Set('stats_nb_replica_seen', $oSetSeen->Count());
  2368. // Job complete!
  2369. $this->m_oStatLog->Set('status_curr_job', 2);
  2370. $this->m_oStatLog->Set('status_curr_pos', -1);
  2371. return false;
  2372. }
  2373. /**
  2374. * Do the synchronization job #2: Create and modify object for new/modified replicas
  2375. * @param integer $iMaxReplica Limit the number of replicas to process
  2376. * @param integer $iCurrPos Current position where to resume the processing
  2377. * @return true if the process must be continued
  2378. */
  2379. protected function DoJob2($iMaxReplica = null, $iCurrPos = -1)
  2380. {
  2381. $sLimitDate = $this->m_oLastFullLoadStartDate->Format('Y-m-d H:i:s');
  2382. // Get all the replicas that are 'new' or modified or synchronized with a warning
  2383. //
  2384. $sSelectToSync = "SELECT SynchroReplica WHERE id > :curr_pos AND (status = 'new' OR status = 'modified' OR (status = 'synchronized' AND status_last_warning != '')) AND sync_source_id = :source_id AND status_last_seen >= :last_import";
  2385. $oSetScope = new DBObjectSet(DBObjectSearch::FromOQL($sSelectToSync), array() /* order by*/, array('source_id' => $this->m_oDataSource->GetKey(), 'last_import' => $sLimitDate, 'curr_pos' => $iCurrPos), $this->m_aExtDataSpec);
  2386. $iCountScope = $oSetScope->Count();
  2387. if ($iMaxReplica)
  2388. {
  2389. // Consider a given subset, starting from replica iCurrPos, limited to the count of iMaxReplica
  2390. // The replica have to be ordered by id
  2391. $oSetToProcess = new DBObjectSet(DBObjectSearch::FromOQL($sSelectToSync), array('id'=>true) /* order by*/, array('source_id' => $this->m_oDataSource->GetKey(), 'last_import' => $sLimitDate, 'curr_pos' => $iCurrPos), $this->m_aExtDataSpec);
  2392. $oSetToProcess->SetLimit($iMaxReplica);
  2393. }
  2394. else
  2395. {
  2396. $oSetToProcess = $oSetScope;
  2397. }
  2398. $iLastReplicaProcessed = -1;
  2399. while($oReplica = $oSetToProcess->Fetch())
  2400. {
  2401. $iLastReplicaProcessed = $oReplica->GetKey();
  2402. $oReplica->Synchro($this->m_oDataSource, $this->m_aReconciliationKeys, $this->m_aAttributes, $this->m_oChange, $this->m_oStatLog);
  2403. $oReplica->DBUpdateTracked($this->m_oChange);
  2404. }
  2405. if ($iMaxReplica)
  2406. {
  2407. if ($iMaxReplica < $iCountScope)
  2408. {
  2409. // Continue with this job!
  2410. $this->m_oStatLog->Set('status_curr_pos', $iLastReplicaProcessed);
  2411. return true;
  2412. }
  2413. }
  2414. // Job complete!
  2415. $this->m_oStatLog->Set('status_curr_job', 3);
  2416. $this->m_oStatLog->Set('status_curr_pos', -1);
  2417. return false;
  2418. }
  2419. /**
  2420. * Do the synchronization job #3: Delete replica depending on the obsolescence scheme
  2421. * @param integer $iMaxReplica Limit the number of replicas to process
  2422. * @param integer $iCurrPos Current position where to resume the processing
  2423. * @return true if the process must be continued
  2424. */
  2425. protected function DoJob3($iMaxReplica = null, $iCurrPos = -1)
  2426. {
  2427. $sDeletePolicy = $this->m_oDataSource->Get('delete_policy');
  2428. if ($sDeletePolicy != 'update_then_delete')
  2429. {
  2430. // Job complete!
  2431. $this->m_oStatLog->Set('status_curr_job', 0);
  2432. $this->m_oStatLog->Set('status_curr_pos', -1);
  2433. return false;
  2434. }
  2435. $bFirstPass = ($iCurrPos == -1);
  2436. // Get all the replicas that are to be deleted
  2437. //
  2438. $oDeletionDate = $this->m_oLastFullLoadStartDate;
  2439. $iDeleteRetention = $this->m_oDataSource->Get('delete_policy_retention'); // Duration in seconds
  2440. if ($iDeleteRetention > 0)
  2441. {
  2442. $sInterval = "-$iDeleteRetention seconds";
  2443. $oDeletionDate->Modify($sInterval);
  2444. }
  2445. $sDeletionDate = $oDeletionDate->Format('Y-m-d H:i:s');
  2446. if ($bFirstPass)
  2447. {
  2448. $this->m_oStatLog->AddTrace("Deletion date: $sDeletionDate");
  2449. }
  2450. $sSelectToDelete = "SELECT SynchroReplica WHERE id > :curr_pos AND sync_source_id = :source_id AND status IN ('obsolete') AND status_last_seen < :last_import";
  2451. $oSetScope = new DBObjectSet(DBObjectSearch::FromOQL($sSelectToDelete), array() /* order by*/, array('source_id' => $this->m_oDataSource->GetKey(), 'last_import' => $sDeletionDate, 'curr_pos' => $iCurrPos));
  2452. $iCountScope = $oSetScope->Count();
  2453. if ($iMaxReplica)
  2454. {
  2455. // Consider a given subset, starting from replica iCurrPos, limited to the count of iMaxReplica
  2456. // The replica have to be ordered by id
  2457. $oSetToProcess = new DBObjectSet(DBObjectSearch::FromOQL($sSelectToDelete), array('id'=>true) /* order by*/, array('source_id' => $this->m_oDataSource->GetKey(), 'last_import' => $sDeletionDate, 'curr_pos' => $iCurrPos));
  2458. $oSetToProcess->SetLimit($iMaxReplica);
  2459. }
  2460. else
  2461. {
  2462. $oSetToProcess = $oSetScope;
  2463. }
  2464. $iLastReplicaProcessed = -1;
  2465. while($oReplica = $oSetToProcess->Fetch())
  2466. {
  2467. $iLastReplicaProcessed = $oReplica->GetKey();
  2468. $this->m_oStatLog->AddTrace("Destination object to be DELETED", $oReplica);
  2469. $oReplica->DeleteDestObject($this->m_oChange, $this->m_oStatLog);
  2470. }
  2471. if ($iMaxReplica)
  2472. {
  2473. if ($iMaxReplica < $iCountScope)
  2474. {
  2475. // Continue with this job!
  2476. $this->m_oStatLog->Set('status_curr_pos', $iLastReplicaProcessed);
  2477. return true;
  2478. }
  2479. }
  2480. // Job complete!
  2481. $this->m_oStatLog->Set('status_curr_job', 0);
  2482. $this->m_oStatLog->Set('status_curr_pos', -1);
  2483. return false;
  2484. }
  2485. }
  2486. $oAdminMenu = new MenuGroup('AdminTools', 80 /* fRank */, 'SynchroDataSource', UR_ACTION_MODIFY, UR_ALLOWED_YES);
  2487. new OQLMenuNode('DataSources', 'SELECT SynchroDataSource', $oAdminMenu->GetIndex(), 12 /* fRank */, true, 'SynchroDataSource', UR_ACTION_MODIFY, UR_ALLOWED_YES);
  2488. // new OQLMenuNode('Replicas', 'SELECT SynchroReplica', $oAdminMenu->GetIndex(), 12 /* fRank */, true, 'SynchroReplica', UR_ACTION_MODIFY, UR_ALLOWED_YES);
  2489. // new WebPageMenuNode('Test:RunSynchro', '../synchro/synchro_exec.php', $oAdminMenu->GetIndex(), 13 /* fRank */, 'SynchroDataSource');
  2490. ?>