synchrodatasource.class.inc.php 114 KB

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