synchrodatasource.class.inc.php 96 KB

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