12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166 |
- <?php
- // Copyright (C) 2010-2016 Combodo SARL
- //
- // This file is part of iTop.
- //
- // iTop is free software; you can redistribute it and/or modify
- // it under the terms of the GNU Affero General Public License as published by
- // the Free Software Foundation, either version 3 of the License, or
- // (at your option) any later version.
- //
- // iTop is distributed in the hope that it will be useful,
- // but WITHOUT ANY WARRANTY; without even the implied warranty of
- // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- // GNU Affero General Public License for more details.
- //
- // You should have received a copy of the GNU Affero General Public License
- // along with iTop. If not, see <http://www.gnu.org/licenses/>
- /**
- * Abstract class that implements some common and useful methods for displaying
- * the objects
- *
- * @copyright Copyright (C) 2010-2016 Combodo SARL
- * @license http://opensource.org/licenses/AGPL-3.0
- */
- define('OBJECT_PROPERTIES_TAB', 'ObjectProperties');
- define('HILIGHT_CLASS_CRITICAL', 'red');
- define('HILIGHT_CLASS_WARNING', 'orange');
- define('HILIGHT_CLASS_OK', 'green');
- define('HILIGHT_CLASS_NONE', '');
- define('MIN_WATCHDOG_INTERVAL', 15); // Minimum interval for the watchdog: 15s
- require_once(APPROOT.'/core/cmdbobject.class.inc.php');
- require_once(APPROOT.'/application/applicationextension.inc.php');
- require_once(APPROOT.'/application/utils.inc.php');
- require_once(APPROOT.'/application/applicationcontext.class.inc.php');
- require_once(APPROOT.'/application/ui.linkswidget.class.inc.php');
- require_once(APPROOT.'/application/ui.linksdirectwidget.class.inc.php');
- require_once(APPROOT.'/application/ui.passwordwidget.class.inc.php');
- require_once(APPROOT.'/application/ui.extkeywidget.class.inc.php');
- require_once(APPROOT.'/application/ui.htmleditorwidget.class.inc.php');
- require_once(APPROOT.'/application/datatable.class.inc.php');
- require_once(APPROOT.'/sources/renderer/console/consoleformrenderer.class.inc.php');
- abstract class cmdbAbstractObject extends CMDBObject implements iDisplay
- {
- protected $m_iFormId; // The ID of the form used to edit the object (when in edition mode !)
- static $iGlobalFormId = 1;
- protected $aFieldsMap;
- /**
- * returns what will be the next ID for the forms
- */
- public static function GetNextFormId()
- {
- return 1 + self::$iGlobalFormId;
- }
- public static function GetUIPage()
- {
- return 'UI.php';
- }
-
- public static function ReloadAndDisplay($oPage, $oObj, $aParams)
- {
- $oAppContext = new ApplicationContext();
- // Reload the page to let the "calling" page execute its 'onunload' method.
- // Note 1: The redirection MUST NOT be made via an HTTP "header" since onunload is only called when the actual content of the DOM
- // is replaced by some other content. So the "bouncing" page must provide some content (in our case a script making the redirection).
- // Note 2: make sure that the URL below is different from the one of the "Modify" button, otherwise the button will have no effect. This is why we add "&a=1" at the end !!!
- // Note 3: we use the toggle of a flag in the sessionStorage object to prevent an infinite loop of reloads in case the object is actually locked by another window
- $sSessionStorageKey = get_class($oObj).'_'.$oObj->GetKey();
- $sParams = '';
- foreach($aParams as $sName => $value)
- {
- $sParams .= $sName.'='.urlencode($value).'&'; // Always add a trailing &
- }
- $sUrl = utils::GetAbsoluteUrlAppRoot().'pages/'.$oObj->GetUIPage().'?'.$sParams.'class='.get_class($oObj).'&id='.$oObj->getKey().'&'.$oAppContext->GetForLink().'&a=1';
- $oPage->add_script(
- <<<EOF
- if (!sessionStorage.getItem('$sSessionStorageKey'))
- {
- sessionStorage.setItem('$sSessionStorageKey', 1);
- window.location.href= "$sUrl";
- }
- else
- {
- sessionStorage.removeItem('$sSessionStorageKey');
- }
- EOF
- );
- $oObj->Reload();
- $oObj->DisplayDetails($oPage, false);
- }
- /**
- * Set a message diplayed to the end-user next time this object will be displayed
- * Messages are uniquely identified so that plugins can override standard messages (the final work is given to the last plugin to set the message for a given message id)
- * In practice, standard messages are recorded at the end but they will not overwrite existing messages
- *
- * @param string $sClass The class of the object (must be the final class)
- * @param int $iKey The identifier of the object
- * @param string $sMessageId Your id or one of the well-known ids: 'create', 'update' and 'apply_stimulus'
- * @param string $sMessage The HTML message (must be correctly escaped)
- * @param string $sSeverity Any of the following: ok, info, error.
- * @param float $fRank Ordering of the message: smallest displayed first (can be negative)
- * @param bool $bMustNotExist Do not alter any existing message (considering the id)
- *
- */
- public static function SetSessionMessage($sClass, $iKey, $sMessageId, $sMessage, $sSeverity, $fRank, $bMustNotExist = false)
- {
- $sMessageKey = $sClass.'::'.$iKey;
- if (!isset($_SESSION['obj_messages'][$sMessageKey]))
- {
- $_SESSION['obj_messages'][$sMessageKey] = array();
- }
- if (!$bMustNotExist || !array_key_exists($sMessageId, $_SESSION['obj_messages'][$sMessageKey]))
- {
- $_SESSION['obj_messages'][$sMessageKey][$sMessageId] = array(
- 'rank' => $fRank,
- 'severity' => $sSeverity,
- 'message' => $sMessage
- );
- }
- }
- function DisplayBareHeader(WebPage $oPage, $bEditMode = false)
- {
- // Standard Header with name, actions menu and history block
- //
-
- if (!$oPage->IsPrintableVersion())
- {
- // Is there a message for this object ??
- $aMessages = array();
- $aRanks = array();
- if (MetaModel::GetConfig()->Get('concurrent_lock_enabled'))
- {
- $aLockInfo = iTopOwnershipLock::IsLocked(get_class($this), $this->GetKey());
- if ($aLockInfo['locked'])
- {
- $aRanks[] = 0;
- $sName = $aLockInfo['owner']->GetName();
- if ($aLockInfo['owner']->Get('contactid') != 0)
- {
- $sName .= ' ('.$aLockInfo['owner']->Get('contactid_friendlyname').')';
- }
- $aResult['message'] = Dict::Format('UI:CurrentObjectIsLockedBy_User', $sName); $aMessages[] = "<div class=\"header_message message_error\">".Dict::Format('UI:CurrentObjectIsLockedBy_User', $sName)."</div>";
- }
- }
- $sMessageKey = get_class($this).'::'.$this->GetKey();
- if (array_key_exists('obj_messages', $_SESSION) && array_key_exists($sMessageKey, $_SESSION['obj_messages']))
- {
- foreach ($_SESSION['obj_messages'][$sMessageKey] as $sMessageId => $aMessageData)
- {
- $sMsgClass = 'message_'.$aMessageData['severity'];
- $aMessages[] = "<div class=\"header_message $sMsgClass\">".$aMessageData['message']."</div>";
- $aRanks[] = $aMessageData['rank'];
- }
- unset($_SESSION['obj_messages'][$sMessageKey]);
- }
- array_multisort($aRanks, $aMessages);
- foreach ($aMessages as $sMessage)
- {
- $oPage->add($sMessage);
- }
- }
-
- if (!$oPage->IsPrintableVersion())
- {
- // action menu
- $oSingletonFilter = new DBObjectSearch(get_class($this));
- $oSingletonFilter->AddCondition('id', $this->GetKey(), '=');
- $oBlock = new MenuBlock($oSingletonFilter, 'details', false);
- $oBlock->Display($oPage, -1);
- }
- $oPage->add("<div class=\"page_header\"><h1>".$this->GetIcon()." \n");
- // Master data sources
- $bSynchronized = false;
- $aIcons = array();
- if (!$oPage->IsPrintableVersion())
- {
- $oCreatorTask = null;
- $bCanBeDeletedByTask = false;
- $bCanBeDeletedByUser = true;
- $aMasterSources = array();
- $aSyncData = $this->GetSynchroData();
- if (count($aSyncData) > 0)
- {
- $bSynchronized = true;
- foreach ($aSyncData as $iSourceId => $aSourceData)
- {
- $oDataSource = $aSourceData['source'];
- $oReplica = reset($aSourceData['replica']); // Take the first one!
-
- $sApplicationURL = $oDataSource->GetApplicationUrl($this, $oReplica);
- $sLink = $oDataSource->GetName();
- if (!empty($sApplicationURL))
- {
- $sLink = "<a href=\"$sApplicationURL\" target=\"_blank\">".$oDataSource->GetName()."</a>";
- }
- if ($oReplica->Get('status_dest_creator') == 1)
- {
- $oCreatorTask = $oDataSource;
- $bCreatedByTask = true;
- }
- else
- {
- $bCreatedByTask = false;
- }
- if ($bCreatedByTask)
- {
- $sDeletePolicy = $oDataSource->Get('delete_policy');
- if (($sDeletePolicy == 'delete') || ($sDeletePolicy == 'update_then_delete'))
- {
- $bCanBeDeletedByTask = true;
- }
- $sUserDeletePolicy = $oDataSource->Get('user_delete_policy');
- if ($sUserDeletePolicy == 'nobody')
- {
- $bCanBeDeletedByUser = false;
- }
- elseif (($sUserDeletePolicy == 'administrators') && !UserRights::IsAdministrator())
- {
- $bCanBeDeletedByUser = false;
- }
- else // everybody...
- {
- }
- }
- $aMasterSources[$iSourceId]['datasource'] = $oDataSource;
- $aMasterSources[$iSourceId]['url'] = $sLink;
- $aMasterSources[$iSourceId]['last_synchro'] = $oReplica->Get('status_last_seen');
- }
-
- if (is_object($oCreatorTask))
- {
- $sTaskUrl = $aMasterSources[$oCreatorTask->GetKey()]['url'];
- if (!$bCanBeDeletedByUser)
- {
- $sTip = "<p>".Dict::Format('Core:Synchro:TheObjectCannotBeDeletedByUser_Source', $sTaskUrl)."</p>";
- }
- else
- {
- $sTip = "<p>".Dict::Format('Core:Synchro:TheObjectWasCreatedBy_Source', $sTaskUrl)."</p>";
- }
- if ($bCanBeDeletedByTask)
- {
- $sTip .= "<p>".Dict::Format('Core:Synchro:TheObjectCanBeDeletedBy_Source', $sTaskUrl)."</p>";
- }
- }
- else
- {
- $sTip = "<p>".Dict::S('Core:Synchro:ThisObjectIsSynchronized')."</p>";
- }
-
- $sTip .= "<p><b>".Dict::S('Core:Synchro:ListOfDataSources')."</b></p>";
- foreach($aMasterSources as $aStruct)
- {
- $oDataSource = $aStruct['datasource'];
- $sLink = $aStruct['url'];
- $sTip .= "<p style=\"white-space:nowrap\">".$oDataSource->GetIcon(true, 'style="vertical-align:middle"')." $sLink<br/>";
- $sTip .= Dict::S('Core:Synchro:LastSynchro').'<br/>'.$aStruct['last_synchro']."</p>";
- }
- $aIcons[] = ' <img style="vertical-align:middle;" id="synchro_icon" src="../images/locked.png"/>';
- $sTip = addslashes($sTip);
- $oPage->add_ready_script("$('#synchro_icon').qtip( { content: '$sTip', show: 'mouseover', hide: { fixed: true }, style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );");
- }
- }
-
- $sIcons = implode(' ', $aIcons);
- $oPage->add(MetaModel::GetName(get_class($this)).": <span class=\"hilite\">".$this->GetName()."</span>$sIcons</h1>\n");
- $oPage->add("</div>\n");
-
- }
- function DisplayBareHistory(WebPage $oPage, $bEditMode = false, $iLimitCount = 0, $iLimitStart = 0)
- {
- // history block (with as a tab)
- $oHistoryFilter = new DBObjectSearch('CMDBChangeOp');
- $oHistoryFilter->AddCondition('objkey', $this->GetKey(), '=');
- $oHistoryFilter->AddCondition('objclass', get_class($this), '=');
- $oBlock = new HistoryBlock($oHistoryFilter, 'table', false);
- $oBlock->SetLimit($iLimitCount, $iLimitStart);
- $oBlock->Display($oPage, 'history');
- }
- function DisplayBareProperties(WebPage $oPage, $bEditMode = false, $sPrefix = '', $aExtraParams = array())
- {
- $aFieldsMap = $this->GetBareProperties($oPage, $bEditMode, $sPrefix, $aExtraParams);
- if (!isset($aExtraParams['disable_plugins']) || !$aExtraParams['disable_plugins'])
- {
- foreach (MetaModel::EnumPlugins('iApplicationUIExtension') as $oExtensionInstance)
- {
- $oExtensionInstance->OnDisplayProperties($this, $oPage, $bEditMode);
- }
- }
- // Special case to display the case log, if any...
- // WARNING: if you modify the loop below, also check the corresponding code in UpdateObject and DisplayModifyForm
- foreach(MetaModel::ListAttributeDefs(get_class($this)) as $sAttCode => $oAttDef)
- {
- if ($oAttDef instanceof AttributeCaseLog)
- {
- $sComment = (isset($aExtraParams['fieldsComments'][$sAttCode])) ? $aExtraParams['fieldsComments'][$sAttCode] : '';
- $this->DisplayCaseLog($oPage, $sAttCode, $sComment, $sPrefix, $bEditMode);
- $aFieldsMap[$sAttCode] = $this->m_iFormId.'_'.$sAttCode;
- }
- }
- return $aFieldsMap;
- }
-
- /**
- * Add a field to the map: attcode => id used when building a form
- * @param string $sAttCode The attribute code of the field being edited
- * @param string $sInputId The unique ID of the control/widget in the page
- */
- protected function AddToFieldsMap($sAttCode, $sInputId)
- {
- $this->aFieldsMap[$sAttCode] = $sInputId;
- }
- function DisplayBareRelations(WebPage $oPage, $bEditMode = false)
- {
- $aRedundancySettings = $this->FindVisibleRedundancySettings();
- // Related objects: display all the linkset attributes, each as a separate tab
- // In the order described by the 'display' ZList
- $aList = $this->FlattenZList(MetaModel::GetZListItems(get_class($this), 'details'));
- if (count($aList) == 0)
- {
- // Empty ZList defined, display all the linkedset attributes defined
- $aList = array_keys(MetaModel::ListAttributeDefs(get_class($this)));
- }
- $sClass = get_class($this);
- foreach($aList as $sAttCode)
- {
- $oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
- // Display mode
- if (!$oAttDef->IsLinkset()) continue; // Process only linkset attributes...
-
- // $oSet = new DBObjectSet($this->Get($sAttCode)->GetFilter()); // Why do something so useless ?
- $oSet = $this->Get($sAttCode);
- $iCount = $oSet->Count();
- $sCount = '';
- if ($iCount != 0)
- {
- $sCount = " ($iCount)";
- }
- $oPage->SetCurrentTab($oAttDef->GetLabel().$sCount);
- if ($this->IsNew())
- {
- $iFlags = $this->GetInitialStateAttributeFlags($sAttCode);
- }
- else
- {
- $iFlags = $this->GetAttributeFlags($sAttCode);
- }
- // Adjust the flags according to user rights
- if ($oAttDef->IsIndirect())
- {
- $sLinkedClass = $oAttDef->GetLinkedClass();
- $oLinkingAttDef = MetaModel::GetAttributeDef($sLinkedClass, $oAttDef->GetExtKeyToRemote());
- $sTargetClass = $oLinkingAttDef->GetTargetClass();
- // n:n links => must be allowed to modify the linking class AND read the target class in order to edit the linkedset
- if (!UserRights::IsActionAllowed($sLinkedClass, UR_ACTION_MODIFY) || !UserRights::IsActionAllowed($sTargetClass, UR_ACTION_READ))
- {
- $iFlags |= OPT_ATT_READONLY;
- }
- // n:n links => must be allowed to read the linking class AND the target class in order to display the linkedset
- if (!UserRights::IsActionAllowed($sLinkedClass, UR_ACTION_READ) || !UserRights::IsActionAllowed($sTargetClass, UR_ACTION_READ))
- {
- $iFlags |= OPT_ATT_HIDDEN;
- }
- }
- else
- {
- // 1:n links => must be allowed to modify the linked class in order to edit the linkedset
- if (!UserRights::IsActionAllowed($oAttDef->GetLinkedClass(), UR_ACTION_MODIFY))
- {
- $iFlags |= OPT_ATT_READONLY;
- }
- // 1:n links => must be allowed to read the linked class in order to display the linkedset
- if (!UserRights::IsActionAllowed($oAttDef->GetLinkedClass(), UR_ACTION_READ))
- {
- $iFlags |= OPT_ATT_HIDDEN;
- }
- }
- // Non-readable/hidden linkedset... don't display anything
- if ($iFlags & OPT_ATT_HIDDEN) continue;
-
- $aArgs = array('this' => $this);
- $bReadOnly = ($iFlags & (OPT_ATT_READONLY|OPT_ATT_SLAVE));
- if ($bEditMode && (!$bReadOnly))
- {
- $sInputId = $this->m_iFormId.'_'.$sAttCode;
- $sLinkedClass = $oAttDef->GetLinkedClass();
- if ($oAttDef->IsIndirect())
- {
- $oLinkingAttDef = MetaModel::GetAttributeDef($sLinkedClass, $oAttDef->GetExtKeyToRemote());
- $sTargetClass = $oLinkingAttDef->GetTargetClass();
- }
- else
- {
- $sTargetClass = $sLinkedClass;
- }
- $oPage->p(MetaModel::GetClassIcon($sTargetClass)." ".$oAttDef->GetDescription().'<span id="busy_'.$sInputId.'"></span>');
- $oValue = $this->Get($sAttCode);
- $sDisplayValue = ''; // not used
- $sHTMLValue = "<span id=\"field_{$sInputId}\">".self::GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef, $oValue, $sDisplayValue, $sInputId, '', $iFlags, $aArgs).'</span>';
- $this->AddToFieldsMap($sAttCode, $sInputId);
- $oPage->add($sHTMLValue);
- }
- else
- {
- // Display mode
- if (!$oAttDef->IsIndirect())
- {
- // 1:n links
- $sTargetClass = $oAttDef->GetLinkedClass();
- $aDefaults = array($oAttDef->GetExtKeyToMe() => $this->GetKey());
- $oAppContext = new ApplicationContext();
- foreach($oAppContext->GetNames() as $sKey)
- {
- // The linked object inherits the parent's value for the context
- if (MetaModel::IsValidAttCode($sClass, $sKey))
- {
- $aDefaults[$sKey] = $this->Get($sKey);
- }
- }
- $aParams = array(
- 'target_attr' => $oAttDef->GetExtKeyToMe(),
- 'object_id' => $this->GetKey(),
- 'menu' => false,
- 'default' => $aDefaults,
- 'table_id' => $sClass.'_'.$sAttCode,
- );
- }
- else
- {
- // n:n links
- $sLinkedClass = $oAttDef->GetLinkedClass();
- $oLinkingAttDef = MetaModel::GetAttributeDef($sLinkedClass, $oAttDef->GetExtKeyToRemote());
- $sTargetClass = $oLinkingAttDef->GetTargetClass();
- $bMenu = ($this->Get($sAttCode)->Count() > 0); // The menu is enabled only if there are already some elements...
- $aParams = array(
- 'link_attr' => $oAttDef->GetExtKeyToMe(),
- 'object_id' => $this->GetKey(),
- 'target_attr' => $oAttDef->GetExtKeyToRemote(),
- 'view_link' => false,
- 'menu' => false,
- 'display_limit' => true, // By default limit the list to speed up the initial load & display
- 'table_id' => $sClass.'_'.$sAttCode,
- );
- }
- $oPage->p(MetaModel::GetClassIcon($sTargetClass)." ".$oAttDef->GetDescription());
- $oBlock = new DisplayBlock($this->Get($sAttCode)->GetFilter(), 'list', false);
- $oBlock->Display($oPage, 'rel_'.$sAttCode, $aParams);
- }
- if (array_key_exists($sAttCode, $aRedundancySettings))
- {
- foreach ($aRedundancySettings[$sAttCode] as $oRedundancyAttDef)
- {
- $sRedundancyAttCode = $oRedundancyAttDef->GetCode();
- $sValue = $this->Get($sRedundancyAttCode);
- $iRedundancyFlags = $this->GetFormAttributeFlags($sRedundancyAttCode);
- $bRedundancyReadOnly = ($iRedundancyFlags & (OPT_ATT_READONLY|OPT_ATT_SLAVE));
- $oPage->add('<fieldset>');
- $oPage->add('<legend>'.$oRedundancyAttDef->GetLabel().'</legend>');
- if ($bEditMode && (!$bRedundancyReadOnly))
- {
- $sInputId = $this->m_iFormId.'_'.$sRedundancyAttCode;
- $oPage->add("<span id=\"field_{$sInputId}\">".self::GetFormElementForField($oPage, $sClass, $sRedundancyAttCode, $oRedundancyAttDef, $sValue, '', $sInputId, '', $iFlags, $aArgs).'</span>');
- }
- else
- {
- $oPage->add($oRedundancyAttDef->GetDisplayForm($sValue, $oPage, false, $this->m_iFormId));
- }
- $oPage->add('</fieldset>');
- }
- }
- }
- $oPage->SetCurrentTab('');
- foreach (MetaModel::EnumPlugins('iApplicationUIExtension') as $oExtensionInstance)
- {
- $oExtensionInstance->OnDisplayRelations($this, $oPage, $bEditMode);
- }
- // Display Notifications after the other tabs since this tab disappears in edition
- if (!$bEditMode)
- {
- // Look for any trigger that considers this object as "In Scope"
- // If any trigger has been found then display a tab with notifications
- //
- $oTriggerSet = new CMDBObjectSet(new DBObjectSearch('Trigger'));
- $aTriggers = array();
- while($oTrigger = $oTriggerSet->Fetch())
- {
- if($oTrigger->IsInScope($this))
- {
- $aTriggers[] = $oTrigger->GetKey();
- }
- }
- if (count($aTriggers) > 0)
- {
- $iId = $this->GetKey();
- $sTriggersList = implode(',', $aTriggers);
- $aNotifSearches = array();
- $iNotifsCount = 0;
- $aNotificationClasses = MetaModel::EnumChildClasses('EventNotification', ENUM_CHILD_CLASSES_EXCLUDETOP);
- foreach($aNotificationClasses as $sNotifClass)
- {
- $aNotifSearches[$sNotifClass] = DBObjectSearch::FromOQL("SELECT $sNotifClass AS Ev JOIN Trigger AS T ON Ev.trigger_id = T.id WHERE T.id IN ($sTriggersList) AND Ev.object_id = $iId");
- $oNotifSet = new DBObjectSet($aNotifSearches[$sNotifClass]);
- $iNotifsCount += $oNotifSet->Count();
- }
- // Display notifications regarding the object: on block per subclass to have the intersting columns
- $sCount = ($iNotifsCount > 0) ? ' ('.$iNotifsCount.')' : '';
- $oPage->SetCurrentTab(Dict::S('UI:NotificationsTab').$sCount);
-
- foreach($aNotificationClasses as $sNotifClass)
- {
-
- $oPage->p(MetaModel::GetClassIcon($sNotifClass, true).' '.MetaModel::GetName($sNotifClass));
- $oBlock = new DisplayBlock($aNotifSearches[$sNotifClass], 'list', false);
- $oBlock->Display($oPage, 'notifications_'.$sNotifClass, array('menu' => false));
- }
- }
- }
- }
- function GetBareProperties(WebPage $oPage, $bEditMode = false, $sPrefix, $aExtraParams = array())
- {
- $sHtml = '';
- $oAppContext = new ApplicationContext();
- $sStateAttCode = MetaModel::GetStateAttributeCode(get_class($this));
- $aDetails = array();
- $sClass = get_class($this);
- $aDetailsList = MetaModel::GetZListItems($sClass, 'details');
- $aDetailsStruct = self::ProcessZlist($aDetailsList, array('UI:PropertiesTab' => array()), 'UI:PropertiesTab', 'col1', '');
- // Compute the list of properties to display, first the attributes in the 'details' list, then
- // all the remaining attributes that are not external fields
- $sHtml = '';
- $aDetails = array();
- $iInputId = 0;
- $aFieldsMap = array();
- $aFieldsComments = (isset($aExtraParams['fieldsComments'])) ? $aExtraParams['fieldsComments'] : array();
- $aExtraFlags = (isset($aExtraParams['fieldsFlags'])) ? $aExtraParams['fieldsFlags'] : array();
- $bFieldComments = (count($aFieldsComments) > 0);
-
- foreach($aDetailsStruct as $sTab => $aCols )
- {
- $aDetails[$sTab] = array();
- ksort($aCols);
- $oPage->SetCurrentTab(Dict::S($sTab));
- $oPage->add('<table style="vertical-align:top"><tr>');
- foreach($aCols as $sColIndex => $aFieldsets)
- {
- $oPage->add('<td style="vertical-align:top">');
- //$aDetails[$sTab][$sColIndex] = array();
- $sLabel = '';
- $sPreviousLabel = '';
- $aDetails[$sTab][$sColIndex] = array();
- foreach($aFieldsets as $sFieldsetName => $aFields)
- {
- if (!empty($sFieldsetName) && ($sFieldsetName[0] != '_'))
- {
- $sLabel = $sFieldsetName;
- }
- else
- {
- $sLabel = '';
- }
- if ($sLabel != $sPreviousLabel)
- {
- if (!empty($sPreviousLabel))
- {
- $oPage->add('<fieldset>');
- $oPage->add('<legend>'.Dict::S($sPreviousLabel).'</legend>');
- }
- $oPage->Details($aDetails[$sTab][$sColIndex]);
- if (!empty($sPreviousLabel))
- {
- $oPage->add('</fieldset>');
- }
- $aDetails[$sTab][$sColIndex] = array();
- $sPreviousLabel = $sLabel;
- }
- foreach($aFields as $sAttCode)
- {
- if ($bEditMode)
- {
- $sComments = isset($aFieldsComments[$sAttCode]) ? $aFieldsComments[$sAttCode] : ' ';
- $sInfos = ' ';
- $iFlags = $this->GetFormAttributeFlags($sAttCode);
- if (array_key_exists($sAttCode, $aExtraFlags))
- {
- // the caller may override some flags if needed
- $iFlags = $iFlags | $aExtraFlags[$sAttCode];
- }
- $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
- if ( (!$oAttDef->IsLinkSet()) && (($iFlags & OPT_ATT_HIDDEN) == 0))
- {
- $sInputId = $this->m_iFormId.'_'.$sAttCode;
- if ($oAttDef->IsWritable())
- {
- if ($sStateAttCode == $sAttCode)
- {
- // State attribute is always read-only from the UI
- $sHTMLValue = $this->GetStateLabel();
- $val = array('label' => '<span>'.$oAttDef->GetLabel().'</span>', 'value' => $sHTMLValue, 'comments' => $sComments, 'infos' => $sInfos);
- }
- else
- {
- if ($iFlags & (OPT_ATT_READONLY|OPT_ATT_SLAVE))
- {
- // Check if the attribute is not read-only because of a synchro...
- $aReasons = array();
- $sSynchroIcon = '';
- if ($iFlags & OPT_ATT_SLAVE)
- {
- $iSynchroFlags = $this->GetSynchroReplicaFlags($sAttCode, $aReasons);
- $sSynchroIcon = " <img id=\"synchro_$sInputId\" src=\"../images/transp-lock.png\" style=\"vertical-align:middle\"/>";
- $sTip = '';
- foreach($aReasons as $aRow)
- {
- $sTip .= "<p>Synchronized with {$aRow['name']} - {$aRow['description']}</p>";
- }
- $sTip = addslashes($sTip);
- $oPage->add_ready_script("$('#synchro_$sInputId').qtip( { content: '$sTip', show: 'mouseover', hide: 'mouseout', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );");
- }
- // Attribute is read-only
- $sHTMLValue = "<span id=\"field_{$sInputId}\">".$this->GetAsHTML($sAttCode).'</span>';
- $sComments = $sSynchroIcon;
- }
- else
- {
- $sValue = $this->Get($sAttCode);
- $sDisplayValue = $this->GetEditValue($sAttCode);
- $aArgs = array('this' => $this, 'formPrefix' => $sPrefix);
- $sHTMLValue = "<span id=\"field_{$sInputId}\">".self::GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef, $sValue, $sDisplayValue, $sInputId, '', $iFlags, $aArgs).'</span>';
- $aFieldsMap[$sAttCode] = $sInputId;
- }
- $val = array('label' => '<span title="'.$oAttDef->GetDescription().'">'.$oAttDef->GetLabel().'</span>', 'value' => $sHTMLValue, 'comments' => $sComments, 'infos' => $sInfos);
- }
- }
- else
- {
- $val = array('label' => '<span title="'.$oAttDef->GetDescription().'">'.$oAttDef->GetLabel().'</span>', 'value' => "<span id=\"field_{$sInputId}\">".$this->GetAsHTML($sAttCode)."</span>", 'comments' => $sComments, 'infos' => $sInfos);
- }
- }
- else
- {
- $val = null; // Skip this field
- }
-
- }
- else
- {
- // !bEditMode
- $val = $this->GetFieldAsHtml($sClass, $sAttCode, $sStateAttCode);
- }
- if ($val != null)
- {
- // The field is visible, add it to the current column
- $aDetails[$sTab][$sColIndex][] = $val;
- $iInputId++;
- }
- }
- }
- if (!empty($sPreviousLabel))
- {
- $oPage->add('<fieldset>');
- $oPage->add('<legend>'.Dict::S($sFieldsetName).'</legend>');
- }
- $oPage->Details($aDetails[$sTab][$sColIndex]);
- if (!empty($sPreviousLabel))
- {
- $oPage->add('</fieldset>');
- }
- $oPage->add('</td>');
- }
- $oPage->add('</tr></table>');
- }
- return $aFieldsMap;
- }
-
- function DisplayDetails(WebPage $oPage, $bEditMode = false)
- {
- $sTemplate = Utils::ReadFromFile(MetaModel::GetDisplayTemplate(get_class($this)));
- if (!empty($sTemplate))
- {
- $oTemplate = new DisplayTemplate($sTemplate);
- // Note: to preserve backward compatibility with home-made templates, the placeholder '$pkey$' has been preserved
- // but the preferred method is to use '$id$'
- $oTemplate->Render($oPage, array('class_name'=> MetaModel::GetName(get_class($this)),'class'=> get_class($this), 'pkey'=> $this->GetKey(), 'id'=> $this->GetKey(), 'name' => $this->GetName()));
- }
- else
- {
- // Object's details
- // template not found display the object using the *old style*
- $this->DisplayBareHeader($oPage, $bEditMode);
- $oPage->AddTabContainer(OBJECT_PROPERTIES_TAB);
- $oPage->SetCurrentTabContainer(OBJECT_PROPERTIES_TAB);
- $oPage->SetCurrentTab(Dict::S('UI:PropertiesTab'));
- $this->DisplayBareProperties($oPage, $bEditMode);
- $this->DisplayBareRelations($oPage, $bEditMode);
- //$oPage->SetCurrentTab(Dict::S('UI:HistoryTab'));
- //$this->DisplayBareHistory($oPage, $bEditMode);
- $oPage->AddAjaxTab(Dict::S('UI:HistoryTab'), utils::GetAbsoluteUrlAppRoot().'pages/ajax.render.php?operation=history&class='.get_class($this).'&id='.$this->GetKey());
- }
- }
-
- function DisplayPreview(WebPage $oPage)
- {
- $aDetails = array();
- $sClass = get_class($this);
- $aList = MetaModel::GetZListItems($sClass, 'preview');
- foreach($aList as $sAttCode)
- {
- $aDetails[] = array('label' => MetaModel::GetLabel($sClass, $sAttCode), 'value' =>$this->GetAsHTML($sAttCode));
- }
- $oPage->details($aDetails);
- }
-
- public static function DisplaySet(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
- {
- $oPage->add(self::GetDisplaySet($oPage, $oSet, $aExtraParams));
- }
-
- /**
- * Simplifed version of GetDisplaySet() with less "decoration" around the table (and no paging)
- * that fits better into a printed document (like a PDF or a printable view)
- * @param WebPage $oPage
- * @param DBObjectSet $oSet
- * @param hash $aExtraParams
- * @return string The HTML representation of the table
- */
- public static function GetDisplaySetForPrinting(WebPage $oPage, DBObjectSet $oSet, $aExtraParams = array())
- {
- $iListId = empty($aExtraParams['currentId']) ? $oPage->GetUniqueId() : $aExtraParams['currentId'];
- $sTableId = isset($aExtraParams['table_id']) ? $aExtraParams['table_id'] : null;
-
- $bViewLink = true;
- $sSelectMode = 'none';
- $iListId = $sTableId;
- $sClassAlias = $oSet->GetClassAlias();
- $sClassName = $oSet->GetClass();
- $sZListName = 'list';
- $aClassAliases = array( $sClassAlias => $sClassName);
- $aList = cmdbAbstractObject::FlattenZList(MetaModel::GetZListItems($sClassName, $sZListName));
-
- $oDataTable = new PrintableDataTable($iListId, $oSet, $aClassAliases, $sTableId);
- $oSettings = DataTableSettings::GetDataModelSettings($aClassAliases, $bViewLink, array($sClassAlias => $aList));
- $oSettings->iDefaultPageSize = 0;
- $oSettings->aSortOrder = MetaModel::GetOrderByDefault($sClassName);
-
- return $oDataTable->Display($oPage, $oSettings, false /* $bDisplayMenu */, $sSelectMode, $bViewLink, $aExtraParams);
-
- }
- /**
- * Get the HTML fragment corresponding to the display of a table representing a set of objects
- * @param WebPage $oPage The page object is used for out-of-band information (mostly scripts) output
- * @param CMDBObjectSet The set of objects to display
- * @param Hash $aExtraParams Some extra configuration parameters to tweak the behavior of the display
- * @return String The HTML fragment representing the table of objects
- */
- public static function GetDisplaySet(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
- {
- if ($oPage->IsPrintableVersion() || $oPage->is_pdf())
- {
- return self::GetDisplaySetForPrinting($oPage, $oSet, $aExtraParams);
- }
- if (empty($aExtraParams['currentId']))
- {
- $iListId = $oPage->GetUniqueId(); // Works only if not in an Ajax page !!
- }
- else
- {
- $iListId = $aExtraParams['currentId'];
- }
-
- // Initialize and check the parameters
- $bViewLink = isset($aExtraParams['view_link']) ? $aExtraParams['view_link'] : true;
- $sLinkageAttribute = isset($aExtraParams['link_attr']) ? $aExtraParams['link_attr'] : '';
- $iLinkedObjectId = isset($aExtraParams['object_id']) ? $aExtraParams['object_id'] : 0;
- $sTargetAttr = isset($aExtraParams['target_attr']) ? $aExtraParams['target_attr'] : '';
- if (!empty($sLinkageAttribute))
- {
- if($iLinkedObjectId == 0)
- {
- // if 'links' mode is requested the id of the object to link to must be specified
- throw new ApplicationException(Dict::S('UI:Error:MandatoryTemplateParameter_object_id'));
- }
- if($sTargetAttr == '')
- {
- // if 'links' mode is requested the d of the object to link to must be specified
- throw new ApplicationException(Dict::S('UI:Error:MandatoryTemplateParameter_target_attr'));
- }
- }
- $bDisplayMenu = isset($aExtraParams['menu']) ? $aExtraParams['menu'] == true : true;
- $bTruncated = isset($aExtraParams['truncated']) ? $aExtraParams['truncated'] == true : true;
- $bSelectMode = isset($aExtraParams['selection_mode']) ? $aExtraParams['selection_mode'] == true : false;
- $bSingleSelectMode = isset($aExtraParams['selection_type']) ? ($aExtraParams['selection_type'] == 'single') : false;
- $aExtraFieldsRaw = isset($aExtraParams['extra_fields']) ? explode(',', trim($aExtraParams['extra_fields'])) : array();
- $aExtraFields = array();
- foreach ($aExtraFieldsRaw as $sFieldName)
- {
- // Ignore attributes not of the main queried class
- if (preg_match('/^(.*)\.(.*)$/', $sFieldName, $aMatches))
- {
- $sClassAlias = $aMatches[1];
- $sAttCode = $aMatches[2];
- if ($sClassAlias == $oSet->GetFilter()->GetClassAlias())
- {
- $aExtraFields[] = $sAttCode;
- }
- }
- else
- {
- $aExtraFields[] = $sFieldName;
- }
- }
- $sHtml = '';
- $oAppContext = new ApplicationContext();
- $sClassName = $oSet->GetFilter()->GetClass();
- $sZListName = isset($aExtraParams['zlist']) ? ($aExtraParams['zlist']) : 'list';
- if ($sZListName !== false)
- {
- $aList = self::FlattenZList(MetaModel::GetZListItems($sClassName, $sZListName));
- $aList = array_merge($aList, $aExtraFields);
- }
- else
- {
- $aList = $aExtraFields;
- }
- // Filter the list to removed linked set since we are not able to display them here
- foreach($aList as $index => $sAttCode)
- {
- $oAttDef = MetaModel::GetAttributeDef($sClassName, $sAttCode);
- if ($oAttDef instanceof AttributeLinkedSet)
- {
- // Removed from the display list
- unset($aList[$index]);
- }
- }
- if (!empty($sLinkageAttribute))
- {
- // The set to display is in fact a set of links between the object specified in the $sLinkageAttribute
- // and other objects...
- // The display will then group all the attributes related to the link itself:
- // | Link_attr1 | link_attr2 | ... || Object_attr1 | Object_attr2 | Object_attr3 | .. | Object_attr_n |
- $aDisplayList = array();
- $aAttDefs = MetaModel::ListAttributeDefs($sClassName);
- assert(isset($aAttDefs[$sLinkageAttribute]));
- $oAttDef = $aAttDefs[$sLinkageAttribute];
- assert($oAttDef->IsExternalKey());
- // First display all the attributes specific to the link record
- foreach($aList as $sLinkAttCode)
- {
- $oLinkAttDef = $aAttDefs[$sLinkAttCode];
- if ( (!$oLinkAttDef->IsExternalKey()) && (!$oLinkAttDef->IsExternalField()) )
- {
- $aDisplayList[] = $sLinkAttCode;
- }
- }
- // Then display all the attributes neither specific to the link record nor to the 'linkage' object (because the latter are constant)
- foreach($aList as $sLinkAttCode)
- {
- $oLinkAttDef = $aAttDefs[$sLinkAttCode];
- if (($oLinkAttDef->IsExternalKey() && ($sLinkAttCode != $sLinkageAttribute))
- || ($oLinkAttDef->IsExternalField() && ($oLinkAttDef->GetKeyAttCode()!=$sLinkageAttribute)) )
- {
- $aDisplayList[] = $sLinkAttCode;
- }
- }
- // First display all the attributes specific to the link
- // Then display all the attributes linked to the other end of the relationship
- $aList = $aDisplayList;
- }
-
- $sSelectMode = 'none';
- if ($bSelectMode)
- {
- $sSelectMode = $bSingleSelectMode ? 'single' : 'multiple';
- }
-
- $sClassAlias = $oSet->GetClassAlias();
- $bDisplayLimit = isset($aExtraParams['display_limit']) ? $aExtraParams['display_limit'] : true;
-
- $sTableId = isset($aExtraParams['table_id']) ? $aExtraParams['table_id'] : null;
- $aClassAliases = array( $sClassAlias => $sClassName);
- $oDataTable = new DataTable($iListId, $oSet, $aClassAliases, $sTableId);
- $oSettings = DataTableSettings::GetDataModelSettings($aClassAliases, $bViewLink, array($sClassAlias => $aList));
-
- if ($bDisplayLimit)
- {
- $iDefaultPageSize = appUserPreferences::GetPref('default_page_size', MetaModel::GetConfig()->GetMinDisplayLimit());
- $oSettings->iDefaultPageSize = $iDefaultPageSize;
- }
- else
- {
- $oSettings->iDefaultPageSize = 0;
- }
- $oSettings->aSortOrder = MetaModel::GetOrderByDefault($sClassName);
-
- return $oDataTable->Display($oPage, $oSettings, $bDisplayMenu, $sSelectMode, $bViewLink, $aExtraParams);
- }
-
- public static function GetDisplayExtendedSet(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
- {
- if (empty($aExtraParams['currentId']))
- {
- $iListId = $oPage->GetUniqueId(); // Works only if not in an Ajax page !!
- }
- else
- {
- $iListId = $aExtraParams['currentId'];
- }
- $aList = array();
-
- // Initialize and check the parameters
- $bViewLink = isset($aExtraParams['view_link']) ? $aExtraParams['view_link'] : true;
- $bDisplayMenu = isset($aExtraParams['menu']) ? $aExtraParams['menu'] == true : true;
- // Check if there is a list of aliases to limit the display to...
- $aDisplayAliases = isset($aExtraParams['display_aliases']) ? explode(',', $aExtraParams['display_aliases']) : array();
- $sZListName = isset($aExtraParams['zlist']) ? ($aExtraParams['zlist']) : 'list';
- $aExtraFieldsRaw = isset($aExtraParams['extra_fields']) ? explode(',', trim($aExtraParams['extra_fields'])) : array();
- $aExtraFields = array();
- foreach ($aExtraFieldsRaw as $sFieldName)
- {
- // Ignore attributes not of the main queried class
- if (preg_match('/^(.*)\.(.*)$/', $sFieldName, $aMatches))
- {
- $sClassAlias = $aMatches[1];
- $sAttCode = $aMatches[2];
- if (array_key_exists($sClassAlias, $oSet->GetSelectedClasses()))
- {
- $aExtraFields[$sClassAlias][] = $sAttCode;
- }
- }
- else
- {
- $aExtraFields['*'] = $sAttCode;
- }
- }
- $sHtml = '';
- $oAppContext = new ApplicationContext();
- $aClasses = $oSet->GetFilter()->GetSelectedClasses();
- $aAuthorizedClasses = array();
- foreach($aClasses as $sAlias => $sClassName)
- {
- if ( (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) && (UR_ALLOWED_YES || UR_ALLOWED_DEPENDS)) &&
- ( (count($aDisplayAliases) == 0) || (in_array($sAlias, $aDisplayAliases))) )
- {
- $aAuthorizedClasses[$sAlias] = $sClassName;
- }
- }
- $aAttribs = array();
- foreach($aAuthorizedClasses as $sAlias => $sClassName)
- {
- if (array_key_exists($sAlias, $aExtraFields))
- {
- $aList[$sAlias] = $aExtraFields[$sAlias];
- }
- else
- {
- $aList[$sAlias] = array();
- }
- if ($sZListName !== false)
- {
- $aDefaultList = self::FlattenZList(MetaModel::GetZListItems($sClassName, $sZListName));
-
- $aList[$sAlias] = array_merge($aDefaultList, $aList[$sAlias]);
- }
-
- // Filter the list to removed linked set since we are not able to display them here
- foreach($aList[$sAlias] as $index => $sAttCode)
- {
- $oAttDef = MetaModel::GetAttributeDef($sClassName, $sAttCode);
- if ($oAttDef instanceof AttributeLinkedSet)
- {
- // Removed from the display list
- unset($aList[$sAlias][$index]);
- }
- }
- }
- $sSelectMode = 'none';
-
- $sClassAlias = $oSet->GetClassAlias();
- $oDataTable = new DataTable($iListId, $oSet, $aAuthorizedClasses);
- $oSettings = DataTableSettings::GetDataModelSettings($aAuthorizedClasses, $bViewLink, $aList);
-
- $bDisplayLimit = isset($aExtraParams['display_limit']) ? $aExtraParams['display_limit'] : true;
- if ($bDisplayLimit)
- {
- $iDefaultPageSize = appUserPreferences::GetPref('default_page_size', MetaModel::GetConfig()->GetMinDisplayLimit());
- $oSettings->iDefaultPageSize = $iDefaultPageSize;
- }
-
- $oSettings->aSortOrder = MetaModel::GetOrderByDefault($sClassName);
-
- return $oDataTable->Display($oPage, $oSettings, $bDisplayMenu, $sSelectMode, $bViewLink, $aExtraParams);
- }
-
- static function DisplaySetAsCSV(WebPage $oPage, CMDBObjectSet $oSet, $aParams = array(), $sCharset = 'UTF-8')
- {
- $oPage->add(self::GetSetAsCSV($oSet, $aParams, $sCharset));
- }
-
- static function GetSetAsCSV(DBObjectSet $oSet, $aParams = array(), $sCharset = 'UTF-8')
- {
- $sSeparator = isset($aParams['separator']) ? $aParams['separator'] : ','; // default separator is comma
- $sTextQualifier = isset($aParams['text_qualifier']) ? $aParams['text_qualifier'] : '"'; // default text qualifier is double quote
- $aFields = null;
- if (isset($aParams['fields']) && (strlen($aParams['fields']) > 0))
- {
- $aFields = explode(',', $aParams['fields']);
- }
- $bFieldsAdvanced = false;
- if (isset($aParams['fields_advanced']))
- {
- $bFieldsAdvanced = (bool) $aParams['fields_advanced'];
- }
- $bLocalize = true;
- if (isset($aParams['localize_values']))
- {
- $bLocalize = (bool) $aParams['localize_values'];
- }
- $aList = array();
- $oAppContext = new ApplicationContext();
- $aClasses = $oSet->GetFilter()->GetSelectedClasses();
- $aAuthorizedClasses = array();
- foreach($aClasses as $sAlias => $sClassName)
- {
- if (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) && (UR_ALLOWED_YES || UR_ALLOWED_DEPENDS))
- {
- $aAuthorizedClasses[$sAlias] = $sClassName;
- }
- }
- $aAttribs = array();
- $aHeader = array();
- foreach($aAuthorizedClasses as $sAlias => $sClassName)
- {
- $aList[$sAlias] = array();
- foreach(MetaModel::ListAttributeDefs($sClassName) as $sAttCode => $oAttDef)
- {
- if (is_null($aFields) || (count($aFields) == 0))
- {
- // Standard list of attributes (no link sets)
- if ($oAttDef->IsScalar() && ($oAttDef->IsWritable() || $oAttDef->IsExternalField()))
- {
- $sAttCodeEx = $oAttDef->IsExternalField() ? $oAttDef->GetKeyAttCode().'->'.$oAttDef->GetExtAttCode() : $sAttCode;
-
- if ($oAttDef->IsExternalKey(EXTKEY_ABSOLUTE))
- {
- if ($bFieldsAdvanced)
- {
- $aList[$sAlias][$sAttCodeEx] = $oAttDef;
- if ($oAttDef->IsExternalKey(EXTKEY_RELATIVE))
- {
- $sRemoteClass = $oAttDef->GetTargetClass();
- foreach(MetaModel::GetReconcKeys($sRemoteClass) as $sRemoteAttCode)
- {
- $aList[$sAlias][$sAttCode.'->'.$sRemoteAttCode] = MetaModel::GetAttributeDef($sRemoteClass, $sRemoteAttCode);
- }
- }
- }
- }
- else
- {
- // Any other attribute
- $aList[$sAlias][$sAttCodeEx] = $oAttDef;
- }
- }
- }
- else
- {
- // User defined list of attributes
- if (in_array($sAttCode, $aFields) || in_array($sAlias.'.'.$sAttCode, $aFields))
- {
- $aList[$sAlias][$sAttCode] = $oAttDef;
- }
- }
- }
- if ($bFieldsAdvanced)
- {
- $aHeader[] = 'id';
- }
- foreach($aList[$sAlias] as $sAttCodeEx => $oAttDef)
- {
- $aHeader[] = $bLocalize ? MetaModel::GetLabel($sClassName, $sAttCodeEx, isset($aParams['showMandatoryFields'])) : $sAttCodeEx;
- }
- }
- $sHtml = implode($sSeparator, $aHeader)."\n";
- $oSet->Seek(0);
- while ($aObjects = $oSet->FetchAssoc())
- {
- $aRow = array();
- foreach($aAuthorizedClasses as $sAlias => $sClassName)
- {
- $oObj = $aObjects[$sAlias];
- if ($bFieldsAdvanced)
- {
- if (is_null($oObj))
- {
- $aRow[] = '';
- }
- else
- {
- $aRow[] = $oObj->GetKey();
- }
- }
- foreach($aList[$sAlias] as $sAttCodeEx => $oAttDef)
- {
- if (is_null($oObj))
- {
- $aRow[] = '';
- }
- else
- {
- $value = $oObj->Get($sAttCodeEx);
- $sCSVValue = $oAttDef->GetAsCSV($value, $sSeparator, $sTextQualifier, $oObj, $bLocalize);
- $aRow[] = iconv('UTF-8', $sCharset.'//IGNORE//TRANSLIT', $sCSVValue);
- }
- }
- }
- $sHtml .= implode($sSeparator, $aRow)."\n";
- }
-
- return $sHtml;
- }
-
- static function DisplaySetAsHTMLSpreadsheet(WebPage $oPage, CMDBObjectSet $oSet, $aParams = array())
- {
- $oPage->add(self::GetSetAsHTMLSpreadsheet($oSet, $aParams));
- }
-
- /**
- * Spreadsheet output: designed for end users doing some reporting
- * Then the ids are excluded and replaced by the corresponding friendlyname
- */
- static function GetSetAsHTMLSpreadsheet(DBObjectSet $oSet, $aParams = array())
- {
- $aFields = null;
- if (isset($aParams['fields']) && (strlen($aParams['fields']) > 0))
- {
- $aFields = explode(',', $aParams['fields']);
- }
- $bFieldsAdvanced = false;
- if (isset($aParams['fields_advanced']))
- {
- $bFieldsAdvanced = (bool) $aParams['fields_advanced'];
- }
- $bLocalize = true;
- if (isset($aParams['localize_values']))
- {
- $bLocalize = (bool) $aParams['localize_values'];
- }
- $aList = array();
- $oAppContext = new ApplicationContext();
- $aClasses = $oSet->GetFilter()->GetSelectedClasses();
- $aAuthorizedClasses = array();
- foreach($aClasses as $sAlias => $sClassName)
- {
- if (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) && (UR_ALLOWED_YES || UR_ALLOWED_DEPENDS))
- {
- $aAuthorizedClasses[$sAlias] = $sClassName;
- }
- }
- $aAttribs = array();
- $aHeader = array();
- foreach($aAuthorizedClasses as $sAlias => $sClassName)
- {
- $aList[$sAlias] = array();
- foreach(MetaModel::ListAttributeDefs($sClassName) as $sAttCode => $oAttDef)
- {
- if (is_null($aFields) || (count($aFields) == 0))
- {
- // Standard list of attributes (no link sets)
- if ($oAttDef->IsScalar() && ($oAttDef->IsWritable() || $oAttDef->IsExternalField()))
- {
- $sAttCodeEx = $oAttDef->IsExternalField() ? $oAttDef->GetKeyAttCode().'->'.$oAttDef->GetExtAttCode() : $sAttCode;
-
- $aList[$sAlias][$sAttCodeEx] = $oAttDef;
- if ($bFieldsAdvanced && $oAttDef->IsExternalKey(EXTKEY_RELATIVE))
- {
- $sRemoteClass = $oAttDef->GetTargetClass();
- foreach(MetaModel::GetReconcKeys($sRemoteClass) as $sRemoteAttCode)
- {
- $aList[$sAlias][$sAttCode.'->'.$sRemoteAttCode] = MetaModel::GetAttributeDef($sRemoteClass, $sRemoteAttCode);
- }
- }
- }
- }
- else
- {
- // User defined list of attributes
- if (in_array($sAttCode, $aFields) || in_array($sAlias.'.'.$sAttCode, $aFields))
- {
- $aList[$sAlias][$sAttCode] = $oAttDef;
- }
- }
- }
- // Replace external key by the corresponding friendly name (if not already in the list)
- foreach($aList[$sAlias] as $sAttCode => $oAttDef)
- {
- if ($oAttDef->IsExternalKey())
- {
- unset($aList[$sAlias][$sAttCode]);
- $sFriendlyNameAttCode = $sAttCode.'_friendlyname';
- if (!array_key_exists($sFriendlyNameAttCode, $aList[$sAlias]) && MetaModel::IsValidAttCode($sClassName, $sFriendlyNameAttCode))
- {
- $oFriendlyNameAtt = MetaModel::GetAttributeDef($sClassName, $sFriendlyNameAttCode);
- $aList[$sAlias][$sFriendlyNameAttCode] = $oFriendlyNameAtt;
- }
- }
- }
- foreach($aList[$sAlias] as $sAttCodeEx => $oAttDef)
- {
- $sColLabel = $bLocalize ? MetaModel::GetLabel($sClassName, $sAttCodeEx) : $sAttCodeEx;
- $oFinalAttDef = $oAttDef->GetFinalAttDef();
- if (get_class($oFinalAttDef) == 'AttributeDateTime')
- {
- $aHeader[] = $sColLabel.' ('.Dict::S('UI:SplitDateTime-Date').')';
- $aHeader[] = $sColLabel.' ('.Dict::S('UI:SplitDateTime-Time').')';
- }
- else
- {
- $aHeader[] = $sColLabel;
- }
- }
- }
- $sHtml = "<table border=\"1\">\n";
- $sHtml .= "<tr>\n";
- $sHtml .= "<td>".implode("</td><td>", $aHeader)."</td>\n";
- $sHtml .= "</tr>\n";
- $oSet->Seek(0);
- while ($aObjects = $oSet->FetchAssoc())
- {
- $aRow = array();
- foreach($aAuthorizedClasses as $sAlias => $sClassName)
- {
- $oObj = $aObjects[$sAlias];
- foreach($aList[$sAlias] as $sAttCodeEx => $oAttDef)
- {
- if (is_null($oObj))
- {
- $aRow[] = '<td></td>';
- }
- else
- {
- $oFinalAttDef = $oAttDef->GetFinalAttDef();
- if (get_class($oFinalAttDef) == 'AttributeDateTime')
- {
- $sDate = $oObj->Get($sAttCodeEx);
- if ($sDate === null)
- {
- $aRow[] = '<td></td>';
- $aRow[] = '<td></td>';
- }
- else
- {
- $iDate = AttributeDateTime::GetAsUnixSeconds($sDate);
- $aRow[] = '<td>'.date('Y-m-d', $iDate).'</td>'; // Format kept as-is for 100% backward compatibility of the exports
- $aRow[] = '<td>'.date('H:i:s', $iDate).'</td>'; // Format kept as-is for 100% backward compatibility of the exports
- }
- }
- else if($oAttDef instanceof AttributeCaseLog)
- {
- $rawValue = $oObj->Get($sAttCodeEx);
- $outputValue = str_replace("\n", "<br/>", htmlentities($rawValue->__toString(), ENT_QUOTES, 'UTF-8'));
- // Trick for Excel: treat the content as text even if it begins with an equal sign
- $aRow[] = '<td x:str>'.$outputValue.'</td>';
- }
- else
- {
- $rawValue = $oObj->Get($sAttCodeEx);
- // Due to custom formatting rules, empty friendlynames may be rendered as non-empty strings
- // let's fix this and make sure we render an empty string if the key == 0
- if ($oAttDef instanceof AttributeFriendlyName)
- {
- $sKeyAttCode = $oAttDef->GetKeyAttCode();
- if ($sKeyAttCode != 'id')
- {
- if ($oObj->Get($sKeyAttCode) == 0)
- {
- $rawValue = '';
- }
- }
- }
- if ($bLocalize)
- {
- $outputValue = htmlentities($oFinalAttDef->GetEditValue($rawValue), ENT_QUOTES, 'UTF-8');
- }
- else
- {
- $outputValue = htmlentities($rawValue, ENT_QUOTES, 'UTF-8');
- }
- $aRow[] = '<td>'.$outputValue.'</td>';
- }
- }
- }
- }
- $sHtml .= implode("\n", $aRow);
- $sHtml .= "</tr>\n";
- }
- $sHtml .= "</table>\n";
-
- return $sHtml;
- }
-
- static function DisplaySetAsXML(WebPage $oPage, CMDBObjectSet $oSet, $aParams = array())
- {
- $bLocalize = true;
- if (isset($aParams['localize_values']))
- {
- $bLocalize = (bool) $aParams['localize_values'];
- }
- $oAppContext = new ApplicationContext();
- $aClasses = $oSet->GetFilter()->GetSelectedClasses();
- $aAuthorizedClasses = array();
- foreach($aClasses as $sAlias => $sClassName)
- {
- if (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) && (UR_ALLOWED_YES || UR_ALLOWED_DEPENDS))
- {
- $aAuthorizedClasses[$sAlias] = $sClassName;
- }
- }
- $aAttribs = array();
- $aList = array();
- $aList[$sAlias] = MetaModel::GetZListItems($sClassName, 'details');
- $oPage->add("<Set>\n");
- $oSet->Seek(0);
- while ($aObjects = $oSet->FetchAssoc())
- {
- if (count($aAuthorizedClasses) > 1)
- {
- $oPage->add("<Row>\n");
- }
- foreach($aAuthorizedClasses as $sAlias => $sClassName)
- {
- $oObj = $aObjects[$sAlias];
- if (is_null($oObj))
- {
- $oPage->add("<$sClassName alias=\"$sAlias\" id=\"null\">\n");
- }
- else
- {
- $sClassName = get_class($oObj);
- $oPage->add("<$sClassName alias=\"$sAlias\" id=\"".$oObj->GetKey()."\">\n");
- }
- foreach(MetaModel::ListAttributeDefs($sClassName) as $sAttCode=>$oAttDef)
- {
- if (is_null($oObj))
- {
- $oPage->add("<$sAttCode>null</$sAttCode>\n");
- }
- else
- {
- if ($oAttDef->IsWritable())
- {
- if (!$oAttDef->IsLinkSet())
- {
- $sValue = $oObj->GetAsXML($sAttCode, $bLocalize);
- $oPage->add("<$sAttCode>$sValue</$sAttCode>\n");
- }
- }
- }
- }
- $oPage->add("</$sClassName>\n");
- }
- if (count($aAuthorizedClasses) > 1)
- {
- $oPage->add("</Row>\n");
- }
- }
- $oPage->add("</Set>\n");
- }
- public static function DisplaySearchForm(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
- {
- $oPage->add(self::GetSearchForm($oPage, $oSet, $aExtraParams));
- }
-
- public static function GetSearchForm(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
- {
- static $iSearchFormId = 0;
- $bMultiSelect = false;
- $oAppContext = new ApplicationContext();
- $sHtml = '';
- $numCols=4;
- $sClassName = $oSet->GetFilter()->GetClass();
- // Romain: temporarily removed the tab "OQL query" because it was not finalized
- // (especially when used to add a link)
- /*
- $sHtml .= "<div class=\"mini_tabs\" id=\"mini_tabs{$iSearchFormId}\"><ul>
- <li><a href=\"#\" onClick=\"$('div.mini_tab{$iSearchFormId}').toggle();$('#mini_tabs{$iSearchFormId} ul li a').toggleClass('selected');\">".Dict::S('UI:OQLQueryTab')."</a></li>
- <li><a class=\"selected\" href=\"#\" onClick=\"$('div.mini_tab{$iSearchFormId}').toggle();$('#mini_tabs{$iSearchFormId} ul li a').toggleClass('selected');\">".Dict::S('UI:SimpleSearchTab')."</a></li>
- </ul></div>\n";
- */
- // Simple search form
- if (isset($aExtraParams['currentId']))
- {
- $sSearchFormId = $aExtraParams['currentId'];
- }
- else
- {
- $iSearchFormId = $oPage->GetUniqueId();
- $sSearchFormId = 'SimpleSearchForm'.$iSearchFormId;
- $sHtml .= "<div id=\"ds_$sSearchFormId\" class=\"mini_tab{$iSearchFormId}\">\n";
- }
- // Check if the current class has some sub-classes
- if (isset($aExtraParams['baseClass']))
- {
- $sRootClass = $aExtraParams['baseClass'];
- }
- else
- {
- $sRootClass = $sClassName;
- }
- $aSubClasses = MetaModel::GetSubclasses($sRootClass);
- if (count($aSubClasses) > 0)
- {
- $aOptions = array();
- $aOptions[MetaModel::GetName($sRootClass)] = "<option value=\"$sRootClass\">".MetaModel::GetName($sRootClass)."</options>\n";
- foreach($aSubClasses as $sSubclassName)
- {
- $aOptions[MetaModel::GetName($sSubclassName)] = "<option value=\"$sSubclassName\">".MetaModel::GetName($sSubclassName)."</options>\n";
- }
- $aOptions[MetaModel::GetName($sClassName)] = "<option selected value=\"$sClassName\">".MetaModel::GetName($sClassName)."</options>\n";
- ksort($aOptions);
- $sContext = $oAppContext->GetForLink();
- $sClassesCombo = "<select name=\"class\" onChange=\"ReloadSearchForm('$sSearchFormId', this.value, '$sRootClass', '$sContext')\">\n".implode('', $aOptions)."</select>\n";
- }
- else
- {
- $sClassesCombo = MetaModel::GetName($sClassName);
- }
- $oUnlimitedFilter = new DBObjectSearch($sClassName);
- $sAction = (isset($aExtraParams['action'])) ? $aExtraParams['action'] : utils::GetAbsoluteUrlAppRoot().'pages/UI.php';
- $sHtml .= "<form id=\"fs_{$sSearchFormId}\" action=\"{$sAction}\">\n"; // Don't use $_SERVER['SCRIPT_NAME'] since the form may be called asynchronously (from ajax.php)
- $sHtml .= "<h2>".Dict::Format('UI:SearchFor_Class_Objects', $sClassesCombo)."</h2>\n";
- $index = 0;
- $sHtml .= "<p>\n";
- $aMapCriteria = array();
- $aList = MetaModel::GetZListItems($sClassName, 'standard_search');
- $aConsts = $oSet->ListConstantFields(); // Some fields are constants based on the query/context
- $sClassAlias = $oSet->GetFilter()->GetClassAlias();
- foreach($aList as $sFilterCode)
- {
- //$oAppContext->Reset($sFilterCode); // Make sure the same parameter will not be passed twice
- $sHtml .= '<span style="white-space: nowrap;padding:5px;display:inline-block;">';
- $sFilterValue = isset($aConsts[$sClassAlias][$sFilterCode]) ? $aConsts[$sClassAlias][$sFilterCode] : '';
- $sFilterValue = utils::ReadParam($sFilterCode, $sFilterValue, false, 'raw_data');
- $sFilterOpCode = null; // Use the default 'loose' OpCode
- if (empty($sFilterValue))
- {
- if (isset($aMapCriteria[$sFilterCode]))
- {
- if (count($aMapCriteria[$sFilterCode]) > 1)
- {
- $sFilterValue = Dict::S('UI:SearchValue:Mixed');
- }
- else
- {
- $sFilterValue = $aMapCriteria[$sFilterCode][0]['value'];
- $sFilterOpCode = $aMapCriteria[$sFilterCode][0]['opcode'];
- }
- // Todo: Investigate...
- if ($sFilterCode != 'company')
- {
- $oUnlimitedFilter->AddCondition($sFilterCode, $sFilterValue, $sFilterOpCode);
- }
- }
- }
- $oAttDef = MetaModel::GetAttributeDef($sClassName, $sFilterCode);
- if ($oAttDef->IsExternalKey(EXTKEY_ABSOLUTE))
- {
- $oKeyAttDef = $oAttDef->GetFinalAttDef();
- $sKeyAttClass = $oKeyAttDef->GetHostClass();
- $sKeyAttCode = $oKeyAttDef->GetCode();
- $sTargetClass = $oKeyAttDef->GetTargetClass();
- $oSearch = new DBObjectSearch($sTargetClass);
- $oSearch->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', true);
- $oAllowedValues = new DBObjectSet($oSearch);
- $iFieldSize = $oKeyAttDef->GetMaxSize();
- $iMaxComboLength = $oKeyAttDef->GetMaximumComboLength();
- $sHtml .= "<label>".MetaModel::GetFilterLabel($sKeyAttClass, $sKeyAttCode).":</label> ";
- $aExtKeyParams = $aExtraParams;
- $aExtKeyParams['iFieldSize'] = $oKeyAttDef->GetMaxSize();
- $aExtKeyParams['iMinChars'] = $oKeyAttDef->GetMinAutoCompleteChars();
- $sHtml .= UIExtKeyWidget::DisplayFromAttCode($oPage, $sKeyAttCode, $sKeyAttClass, $oAttDef->GetLabel(), $oAllowedValues, $sFilterValue, $sSearchFormId.'search_'.$sFilterCode, false, $sFilterCode, '', $aExtKeyParams, true);
- }
- else
- {
- $aAllowedValues = MetaModel::GetAllowedValues_flt($sClassName, $sFilterCode, $aExtraParams);
- if (is_null($aAllowedValues))
- {
- // Any value is possible, display an input box
- $sHtml .= "<label>".MetaModel::GetFilterLabel($sClassName, $sFilterCode).":</label> <input class=\"textSearch\" name=\"$sFilterCode\" value=\"".htmlentities($sFilterValue, ENT_QUOTES, 'utf-8')."\"/>\n";
- }
- else
- {
- //Enum field, display a multi-select combo
- $sValue = "<select class=\"multiselect\" size=\"1\" name=\"{$sFilterCode}[]\" multiple>\n";
- $bMultiSelect = true;
- //$sValue .= "<option value=\"\">".Dict::S('UI:SearchValue:Any')."</option>\n";
- asort($aAllowedValues);
- foreach($aAllowedValues as $key => $value)
- {
- if (is_array($sFilterValue) && in_array($key, $sFilterValue))
- {
- $sSelected = ' selected';
- }
- else if ($sFilterValue == $key)
- {
- $sSelected = ' selected';
- }
- else
- {
- $sSelected = '';
- }
- $sValue .= "<option value=\"$key\"$sSelected>$value</option>\n";
- }
- $sValue .= "</select>\n";
- $sHtml .= "<label>".MetaModel::GetFilterLabel($sClassName, $sFilterCode).":</label> $sValue\n";
- }
- }
- unset($aExtraParams[$sFilterCode]);
-
- // Finally, add a tooltip if one is defined for this attribute definition
- $sTip = $oAttDef->GetHelpOnSmartSearch();
- if (strlen($sTip) > 0)
- {
- $sTip = addslashes($sTip);
- $sTip = str_replace(array("\n", "\r"), " ", $sTip);
- // :input does represent in form visible input (INPUT, SELECT, TEXTAREA)
- $oPage->add_ready_script("$('form#fs_$sSearchFormId :input[name={$sFilterCode}]').qtip( { content: '$sTip', show: 'mouseover', hide: 'mouseout', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );");
- }
- $index++;
- $sHtml .= '</span> ';
- }
- $sHtml .= "</p>\n";
- $sHtml .= "<p align=\"right\"><input type=\"submit\" value=\"".Dict::S('UI:Button:Search')."\"></p>\n";
- if (isset($aExtraParams['table_id']))
- {
- // Rename to avoid collisions...
- $aExtraParams['_table_id_'] = $aExtraParams['table_id'];
- unset($aExtraParams['table_id']);
- }
- foreach($aExtraParams as $sName => $sValue)
- {
- if (is_scalar($sValue))
- {
- $sHtml .= "<input type=\"hidden\" name=\"$sName\" value=\"".htmlentities($sValue, ENT_QUOTES, 'UTF-8')."\" />\n";
- }
- }
- $sHtml .= "<input type=\"hidden\" name=\"class\" value=\"$sClassName\" />\n";
- $sHtml .= "<input type=\"hidden\" name=\"dosearch\" value=\"1\" />\n";
- $sHtml .= "<input type=\"hidden\" name=\"operation\" value=\"search_form\" />\n";
- $sHtml .= $oAppContext->GetForForm();
- $sHtml .= "</form>\n";
- if (!isset($aExtraParams['currentId']))
- {
- $sHtml .= "</div><!-- Simple search form -->\n";
- }
- if ($bMultiSelect)
- {
- $aOptions = array(
- 'header' => true,
- 'checkAllText' => Dict::S('UI:SearchValue:CheckAll'),
- 'uncheckAllText' => Dict::S('UI:SearchValue:UncheckAll'),
- 'noneSelectedText' => Dict::S('UI:SearchValue:Any'),
- 'selectedText' => Dict::S('UI:SearchValue:NbSelected'),
- 'selectedList' => 1,
- );
- $sJSOptions = json_encode($aOptions);
- $oPage->add_ready_script("$('.multiselect').multiselect($sJSOptions);");
- }
- /*
- // OQL query builder
- $sHtml .= "<div id=\"OQLQuery{$iSearchFormId}\" style=\"display:none\" class=\"mini_tab{$iSearchFormId}\">\n";
- $sHtml .= "<h1>".Dict::S('UI:OQLQueryBuilderTitle')."</h1>\n";
- $sHtml .= "<form id=\"formOQL{$iSearchFormId}\"><table style=\"width:80%;\"><tr style=\"vertical-align:top\">\n";
- $sHtml .= "<td style=\"text-align:right\"><label>SELECT </label><select name=\"oql_class\">";
- $aClasses = MetaModel::EnumChildClasses($sClassName, ENUM_CHILD_CLASSES_ALL);
- $sSelectedClass = utils::ReadParam('oql_class', $sClassName, false, 'class');
- $sOQLClause = utils::ReadParam('oql_clause', '', false, 'raw_data');
- asort($aClasses);
- foreach($aClasses as $sChildClass)
- {
- $sSelected = ($sChildClass == $sSelectedClass) ? 'selected' : '';
- $sHtml.= "<option value=\"$sChildClass\" $sSelected>".MetaModel::GetName($sChildClass)."</option>\n";
- }
- $sHtml .= "</select> </td><td>\n";
- $sHtml .= "<textarea name=\"oql_clause\" style=\"width:100%\">$sOQLClause</textarea></td></tr>\n";
- $sHtml .= "<tr><td colspan=\"2\" style=\"text-align:right\"><input type=\"submit\" value=\"".Dict::S('UI:Button:Query')."\"></td></tr>\n";
- $sHtml .= "<input type=\"hidden\" name=\"dosearch\" value=\"1\" />\n";
- foreach($aExtraParams as $sName => $sValue)
- {
- if (is_scalar($sValue))
- {
- $sHtml .= "<input type=\"hidden\" name=\"$sName\" value=\"$sValue\" />\n";
- }
- }
- $sHtml .= "<input type=\"hidden\" name=\"operation\" value=\"search_oql\" />\n";
- $sHtml .= $oAppContext->GetForForm();
- $sHtml .= "</table></form>\n";
- $sHtml .= "</div><!-- OQL query form -->\n";
- */
- return $sHtml;
- }
-
- public static function GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef, $value = '', $sDisplayValue = '', $iId = '', $sNameSuffix = '', $iFlags = 0, $aArgs = array())
- {
- static $iInputId = 0;
- $sFieldPrefix = '';
- $sFormPrefix = isset($aArgs['formPrefix']) ? $aArgs['formPrefix'] : '';
- $sFieldPrefix = isset($aArgs['prefix']) ? $sFormPrefix.$aArgs['prefix'] : $sFormPrefix;
- if ($sDisplayValue == '')
- {
- $sDisplayValue = $value;
- }
- if (isset($aArgs[$sAttCode]) && empty($value))
- {
- // default value passed by the context (either the app context of the operation)
- $value = $aArgs[$sAttCode];
- }
- if (!empty($iId))
- {
- $iInputId = $iId;
- }
- else
- {
- $iInputId = $oPage->GetUniqueId();
- }
- if (!$oAttDef->IsExternalField())
- {
- $bMandatory = 'false';
- if ( (!$oAttDef->IsNullAllowed()) || ($iFlags & OPT_ATT_MANDATORY))
- {
- $bMandatory = 'true';
- }
- $sValidationSpan = "<span class=\"form_validation\" id=\"v_{$iId}\"></span>";
- $sReloadSpan = "<span class=\"field_status\" id=\"fstatus_{$iId}\"></span>";
- $sHelpText = htmlentities($oAttDef->GetHelpOnEdition(), ENT_QUOTES, 'UTF-8');
- $aEventsList = array();
- switch($oAttDef->GetEditClass())
- {
- case 'Date':
- $aEventsList[] ='validate';
- $aEventsList[] ='keyup';
- $aEventsList[] ='change';
- $sPlaceholderValue = 'placeholder="'.htmlentities(AttributeDate::GetFormat()->ToPlaceholder(), ENT_QUOTES, 'UTF-8').'"';
- $sHTMLValue = "<input title=\"$sHelpText\" class=\"date-pick\" type=\"text\" size=\"12\" $sPlaceholderValue name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" value=\"".htmlentities($sDisplayValue, ENT_QUOTES, 'UTF-8')."\" id=\"$iId\"/> {$sValidationSpan}{$sReloadSpan}";
- break;
- case 'DateTime':
- $aEventsList[] ='validate';
- $aEventsList[] ='keyup';
- $aEventsList[] ='change';
- $sPlaceholderValue = 'placeholder="'.htmlentities(AttributeDateTime::GetFormat()->ToPlaceholder(), ENT_QUOTES, 'UTF-8').'"';
- $sHTMLValue = "<input title=\"$sHelpText\" class=\"datetime-pick\" type=\"text\" size=\"15\" $sPlaceholderValue name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" value=\"".htmlentities($sDisplayValue, ENT_QUOTES, 'UTF-8')."\" id=\"$iId\"/> {$sValidationSpan}{$sReloadSpan}";
- break;
- case 'Duration':
- $aEventsList[] ='validate';
- $aEventsList[] ='change';
- $oPage->add_ready_script("$('#{$iId}_d').bind('keyup change', function(evt, sFormId) { return UpdateDuration('$iId'); });");
- $oPage->add_ready_script("$('#{$iId}_h').bind('keyup change', function(evt, sFormId) { return UpdateDuration('$iId'); });");
- $oPage->add_ready_script("$('#{$iId}_m').bind('keyup change', function(evt, sFormId) { return UpdateDuration('$iId'); });");
- $oPage->add_ready_script("$('#{$iId}_s').bind('keyup change', function(evt, sFormId) { return UpdateDuration('$iId'); });");
- $aVal = AttributeDuration::SplitDuration($value);
- $sDays = "<input title=\"$sHelpText\" type=\"text\" style=\"text-align:right\" size=\"3\" name=\"attr_{$sFieldPrefix}{$sAttCode}[d]{$sNameSuffix}\" value=\"{$aVal['days']}\" id=\"{$iId}_d\"/>";
- $sHours = "<input title=\"$sHelpText\" type=\"text\" style=\"text-align:right\" size=\"2\" name=\"attr_{$sFieldPrefix}{$sAttCode}[h]{$sNameSuffix}\" value=\"{$aVal['hours']}\" id=\"{$iId}_h\"/>";
- $sMinutes = "<input title=\"$sHelpText\" type=\"text\" style=\"text-align:right\" size=\"2\" name=\"attr_{$sFieldPrefix}{$sAttCode}[m]{$sNameSuffix}\" value=\"{$aVal['minutes']}\" id=\"{$iId}_m\"/>";
- $sSeconds = "<input title=\"$sHelpText\" type=\"text\" style=\"text-align:right\" size=\"2\" name=\"attr_{$sFieldPrefix}{$sAttCode}[s]{$sNameSuffix}\" value=\"{$aVal['seconds']}\" id=\"{$iId}_s\"/>";
- $sHidden = "<input type=\"hidden\" id=\"{$iId}\" value=\"".htmlentities($value, ENT_QUOTES, 'UTF-8')."\"/>";
- $sHTMLValue = Dict::Format('UI:DurationForm_Days_Hours_Minutes_Seconds', $sDays, $sHours, $sMinutes, $sSeconds).$sHidden." ".$sValidationSpan.$sReloadSpan;
- $oPage->add_ready_script("$('#{$iId}').bind('update', function(evt, sFormId) { return ToggleDurationField('$iId'); });");
- break;
-
- case 'Password':
- $aEventsList[] ='validate';
- $aEventsList[] ='keyup';
- $aEventsList[] ='change';
- $sHTMLValue = "<input title=\"$sHelpText\" type=\"password\" size=\"30\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" value=\"".htmlentities($value, ENT_QUOTES, 'UTF-8')."\" id=\"$iId\"/> {$sValidationSpan}{$sReloadSpan}";
- break;
-
- case 'OQLExpression':
- case 'Text':
- $aEventsList[] ='validate';
- $aEventsList[] ='keyup';
- $aEventsList[] ='change';
- $sEditValue = $oAttDef->GetEditValue($value);
- $aStyles = array();
- $sStyle = '';
- $sWidth = $oAttDef->GetWidth('width', '');
- if (!empty($sWidth))
- {
- $aStyles[] = 'width:'.$sWidth;
- }
- $sHeight = $oAttDef->GetHeight('height', '');
- if (!empty($sHeight))
- {
- $aStyles[] = 'height:'.$sHeight;
- }
- if (count($aStyles) > 0)
- {
- $sStyle = 'style="'.implode('; ', $aStyles).'"';
- }
- if ($oAttDef->GetEditClass() == 'OQLExpression')
- {
- $sTestResId = 'query_res_'.$sFieldPrefix.$sAttCode.$sNameSuffix; //$oPage->GetUniqueId();
- $sBaseUrl = utils::GetAbsoluteUrlAppRoot().'pages/run_query.php?expression=';
- $sInitialUrl = $sBaseUrl.urlencode($sEditValue);
- $sAdditionalStuff = "<a id=\"$sTestResId\" target=\"_blank\" href=\"$sInitialUrl\">".Dict::S('UI:Edit:TestQuery')."</a>";
- $oPage->add_ready_script("$('#$iId').bind('change keyup', function(evt, sFormId) { $('#$sTestResId').attr('href', '$sBaseUrl'+encodeURIComponent($(this).val())); } );");
- }
- else
- {
- $sAdditionalStuff = "";
- }
- // Ok, the text area is drawn here
- $sHTMLValue = "<table><tr><td><textarea class=\"resizable\" title=\"$sHelpText\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" rows=\"8\" cols=\"40\" id=\"$iId\" $sStyle>".htmlentities($sEditValue, ENT_QUOTES, 'UTF-8')."</textarea>$sAdditionalStuff</td><td>{$sValidationSpan}{$sReloadSpan}</td></tr></table>";
- break;
- case 'CaseLog':
- $aStyles = array();
- $sStyle = '';
- $sWidth = $oAttDef->GetWidth('width', '');
- if (!empty($sWidth))
- {
- $aStyles[] = 'width:'.$sWidth;
- }
- $sHeight = $oAttDef->GetHeight('height', '');
- if (!empty($sHeight))
- {
- $aStyles[] = 'height:'.$sHeight;
- }
- if (count($aStyles) > 0)
- {
- $sStyle = 'style="'.implode('; ', $aStyles).'"';
- }
- $sHeader = '<div class="caselog_input_header"></div>'; // will be hidden in CSS (via :empty) if it remains empty
- $sEditValue = $oAttDef->GetEditValue($value);
- $sPreviousLog = is_object($value) ? $value->GetAsHTML($oPage, true /* bEditMode */, array('AttributeText', 'RenderWikiHtml')) : '';
- $iEntriesCount = is_object($value) ? count($value->GetIndex()) : 0;
- $sHidden = "<input type=\"hidden\" id=\"{$iId}_count\" value=\"$iEntriesCount\"/>"; // To know how many entries the case log already contains
- $sHTMLValue = "<div class=\"caselog\" $sStyle><table style=\"width:100%;\"><tr><td>$sHeader<textarea class=\"htmlEditor\" style=\"border:0;width:100%\" title=\"$sHelpText\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" rows=\"8\" cols=\"40\" id=\"$iId\">".htmlentities($sEditValue, ENT_QUOTES, 'UTF-8')."</textarea>$sPreviousLog</td><td>{$sValidationSpan}{$sReloadSpan}</td></tr></table>$sHidden</div>";
- $oPage->add_ready_script("$('#$iId').bind('keyup change validate', function(evt, sFormId) { return ValidateCaseLogField('$iId', $bMandatory, sFormId) } );"); // Custom validation function
- break;
- case 'HTML':
- $oWidget = new UIHTMLEditorWidget($iId, $oAttDef, $sNameSuffix, $sFieldPrefix, $sHelpText, $sValidationSpan.$sReloadSpan, $value, $bMandatory);
- $sHTMLValue = $oWidget->Display($oPage, $aArgs);
- break;
- case 'LinkedSet':
- if ($oAttDef->IsIndirect())
- {
- $oWidget = new UILinksWidget($sClass, $sAttCode, $iId, $sNameSuffix, $oAttDef->DuplicatesAllowed(), $aArgs);
- }
- else
- {
- $oWidget = new UILinksWidgetDirect($sClass, $sAttCode, $iId, $sNameSuffix, $aArgs);
- }
- $aEventsList[] ='validate';
- $aEventsList[] ='change';
- $oObj = isset($aArgs['this']) ? $aArgs['this'] : null;
- $sHTMLValue = $oWidget->Display($oPage, $value, array(), $sFormPrefix, $oObj);
- break;
-
- case 'Document':
- $aEventsList[] ='validate';
- $aEventsList[] ='change';
- $oDocument = $value; // Value is an ormDocument object
- $sFileName = '';
- if (is_object($oDocument))
- {
- $sFileName = $oDocument->GetFileName();
- }
- $iMaxFileSize = utils::ConvertToBytes(ini_get('upload_max_filesize'));
- $sHTMLValue = "<input type=\"hidden\" name=\"MAX_FILE_SIZE\" value=\"$iMaxFileSize\" />\n";
- $sHTMLValue .= "<input name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}[filename]\" type=\"hidden\" id=\"$iId\" \" value=\"".htmlentities($sFileName, ENT_QUOTES, 'UTF-8')."\"/>\n";
- $sHTMLValue .= "<span id=\"name_$iInputId\">".htmlentities($sFileName, ENT_QUOTES, 'UTF-8')."</span><br/>\n";
- $sHTMLValue .= "<input title=\"$sHelpText\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}[fcontents]\" type=\"file\" id=\"file_$iId\" onChange=\"UpdateFileName('$iId', this.value)\"/> {$sValidationSpan}{$sReloadSpan}\n";
- break;
-
- case 'StopWatch':
- $sHTMLValue = "The edition of a stopwatch is not allowed!!!";
- break;
- case 'List':
- // Not editable for now...
- $sHTMLValue = '';
- break;
-
- case 'One Way Password':
- $aEventsList[] ='validate';
- $oWidget = new UIPasswordWidget($sAttCode, $iId, $sNameSuffix);
- $sHTMLValue = $oWidget->Display($oPage, $aArgs);
- // Event list & validation is handled directly by the widget
- break;
-
- case 'ExtKey':
- $aEventsList[] ='validate';
- $aEventsList[] ='change';
- $oAllowedValues = MetaModel::GetAllowedValuesAsObjectSet($sClass, $sAttCode, $aArgs);
- $sFieldName = $sFieldPrefix.$sAttCode.$sNameSuffix;
- $aExtKeyParams = $aArgs;
- $aExtKeyParams['iFieldSize'] = $oAttDef->GetMaxSize();
- $aExtKeyParams['iMinChars'] = $oAttDef->GetMinAutoCompleteChars();
- $sHTMLValue = UIExtKeyWidget::DisplayFromAttCode($oPage, $sAttCode, $sClass, $oAttDef->GetLabel(), $oAllowedValues, $value, $iId, $bMandatory, $sFieldName, $sFormPrefix, $aExtKeyParams);
- $sHTMLValue .= "<!-- iFlags: $iFlags bMandatory: $bMandatory -->\n";
- break;
-
- case 'RedundancySetting':
- $sHTMLValue = '<table>';
- $sHTMLValue .= '<tr>';
- $sHTMLValue .= '<td>';
- $sHTMLValue .= '<div id="'.$iId.'">';
- $sHTMLValue .= $oAttDef->GetDisplayForm($value, $oPage, true);
- $sHTMLValue .= '</div>';
- $sHTMLValue .= '</td>';
- $sHTMLValue .= '<td>'.$sValidationSpan.$sReloadSpan.'</td>';
- $sHTMLValue .= '</tr>';
- $sHTMLValue .= '</table>';
- $oPage->add_ready_script("$('#$iId :input').bind('keyup change validate', function(evt, sFormId) { return ValidateRedundancySettings('$iId',sFormId); } );"); // Custom validation function
- break;
- case 'CustomFields':
- $sHTMLValue = '<table>';
- $sHTMLValue .= '<tr>';
- $sHTMLValue .= '<td>';
- $sHTMLValue .= '<div id="'.$iId.'_console_form">';
- $sHTMLValue .= '<div id="'.$iId.'_field_set">';
- $sHTMLValue .= '</div>';
- $sHTMLValue .= '</div>';
- $sHTMLValue .= '</td>';
- $sHTMLValue .= '<td>'.$sReloadSpan.'</td>'; // No validation span for this one: it does handle its own validation!
- $sHTMLValue .= '</tr>';
- $sHTMLValue .= '</table>';
- $sHTMLValue .= "<input name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" type=\"hidden\" id=\"$iId\" value=\"\"/>\n";
- $oForm = $value->GetForm($sFormPrefix);
- $oRenderer = new \Combodo\iTop\Renderer\Console\ConsoleFormRenderer($oForm);
- $aRenderRes = $oRenderer->Render();
- $aFormHandlerOptions = array(
- 'wizard_helper_var_name' => 'oWizardHelper'.$sFormPrefix,
- 'custom_field_attcode' => $sAttCode
- );
- $sFormHandlerOptions = json_encode($aFormHandlerOptions);
- $aFieldSetOptions = array(
- 'field_identifier_attr' => 'data-field-id', // convention: fields are rendered into a div and are identified by this attribute
- 'fields_list' => $aRenderRes,
- 'fields_impacts' => $oForm->GetFieldsImpacts(),
- 'form_path' => $oForm->GetId()
- );
- $sFieldSetOptions = json_encode($aFieldSetOptions);
- $oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/form_handler.js');
- $oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/console_form_handler.js');
- $oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/field_set.js');
- $oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/form_field.js');
- $oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/subform_field.js');
- $oPage->add_ready_script("$('#{$iId}_console_form').console_form_handler($sFormHandlerOptions);");
- $oPage->add_ready_script("$('#{$iId}_field_set').field_set($sFieldSetOptions);");
- $oPage->add_ready_script("$('#{$iId}_console_form').console_form_handler('alignColumns');");
- $oPage->add_ready_script("$('#{$iId}_console_form').console_form_handler('option', 'field_set', $('#{$iId}_field_set'));");
- // field_change must be processed to refresh the hidden value at anytime
- $oPage->add_ready_script("$('#{$iId}_console_form').bind('value_change', function() { $('#{$iId}').val(JSON.stringify($('#{$iId}_field_set').triggerHandler('get_current_values'))); });");
- // Initialize the hidden value with current state
- $oPage->add_ready_script("$('#{$iId}_console_form').trigger('value_change');");
- // update_value is triggered when preparing the wizard helper object for ajax calls
- $oPage->add_ready_script("$('#{$iId}').bind('update_value', function() { $(this).val(JSON.stringify($('#{$iId}_field_set').triggerHandler('get_current_values'))); });");
- // validate is triggered by CheckFields, on all the input fields, once at page init and once before submitting the form
- $oPage->add_ready_script("$('#{$iId}').bind('validate', function(evt, sFormId) { return ValidateCustomFields('$iId', sFormId) } );"); // Custom validation function
- break;
- case 'String':
- default:
- $aEventsList[] ='validate';
- // #@# todo - add context information (depending on dimensions)
- $aAllowedValues = MetaModel::GetAllowedValues_att($sClass, $sAttCode, $aArgs);
- $iFieldSize = $oAttDef->GetMaxSize();
- if ($aAllowedValues !== null)
- {
- // Discrete list of values, use a SELECT or RADIO buttons depending on the config
- $sDisplayStyle = $oAttDef->GetDisplayStyle();
- switch($sDisplayStyle)
- {
- case 'radio':
- case 'radio_horizontal':
- case 'radio_vertical':
- $sHTMLValue = '';
- $bVertical = ($sDisplayStyle != 'radio_horizontal');
- $sHTMLValue = $oPage->GetRadioButtons($aAllowedValues, $value, $iId, "attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}", $bMandatory, $bVertical, $sValidationSpan.$sReloadSpan);
- $aEventsList[] ='change';
- break;
-
- case 'select':
- default:
- $sHTMLValue = "<select title=\"$sHelpText\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" id=\"$iId\">\n";
- $sHTMLValue .= "<option value=\"\">".Dict::S('UI:SelectOne')."</option>\n";
- foreach($aAllowedValues as $key => $display_value)
- {
- if ((count($aAllowedValues) == 1) && ($bMandatory == 'true') )
- {
- // When there is only once choice, select it by default
- $sSelected = ' selected';
- }
- else
- {
- $sSelected = ($value == $key) ? ' selected' : '';
- }
- $sHTMLValue .= "<option value=\"$key\"$sSelected>$display_value</option>\n";
- }
- $sHTMLValue .= "</select> {$sValidationSpan}{$sReloadSpan}\n";
- $aEventsList[] ='change';
- }
- }
- else
- {
- $sHTMLValue = "<input title=\"$sHelpText\" type=\"text\" size=\"30\" maxlength=\"$iFieldSize\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" value=\"".htmlentities($sDisplayValue, ENT_QUOTES, 'UTF-8')."\" id=\"$iId\"/> {$sValidationSpan}{$sReloadSpan}";
- $aEventsList[] ='keyup';
- $aEventsList[] ='change';
- }
- break;
- }
- $sPattern = addslashes($oAttDef->GetValidationPattern()); //'^([0-9]+)$';
- if (!empty($aEventsList))
- {
- $sNullValue = $oAttDef->GetNullValue();
- if (!is_numeric($sNullValue))
- {
- $sNullValue = "'$sNullValue'"; // Add quotes to turn this into a JS string if it's not a number
- }
- $sOriginalValue = ($iFlags & OPT_ATT_MUSTCHANGE) ? json_encode($value) : 'undefined';
- $oPage->add_ready_script("$('#$iId').bind('".implode(' ', $aEventsList)."', function(evt, sFormId) { return ValidateField('$iId', '$sPattern', $bMandatory, sFormId, $sNullValue, $sOriginalValue) } );\n"); // Bind to a custom event: validate
- }
- $aDependencies = MetaModel::GetDependentAttributes($sClass, $sAttCode); // List of attributes that depend on the current one
- if (count($aDependencies) > 0)
- {
- // Unbind first to avoid duplicate event handlers in case of reload of the whole (or part of the) form
- $oPage->add_ready_script("$('#$iId').unbind('change.dependencies').bind('change.dependencies', function(evt, sFormId) { return oWizardHelper{$sFormPrefix}.UpdateDependentFields(['".implode("','", $aDependencies)."']) } );\n"); // Bind to a custom event: validate
- }
- }
- $oPage->add_dict_entry('UI:ValueMustBeSet');
- $oPage->add_dict_entry('UI:ValueMustBeChanged');
- $oPage->add_dict_entry('UI:ValueInvalidFormat');
- return "<div>{$sHTMLValue}</div>";
- }
- public function DisplayModifyForm(WebPage $oPage, $aExtraParams = array())
- {
- $sOwnershipToken = null;
- $iKey = $this->GetKey();
- $sClass = get_class($this);
- if ($iKey > 0)
- {
- // The concurrent access lock makes sense only for already existing objects
- $LockEnabled = MetaModel::GetConfig()->Get('concurrent_lock_enabled');
- if ($LockEnabled)
- {
- $sOwnershipToken = utils::ReadPostedParam('ownership_token', null, false, 'raw_data');
- if ($sOwnershipToken !== null)
- {
- // We're probably inside something like "apply_modify" where the validation failed and we must prompt the user again to edit the object
- // let's extend our lock
- $aLockInfo = iTopOwnershipLock::ExtendLock($sClass, $iKey, $sOwnershipToken);
- $sOwnershipDate = $aLockInfo['acquired'];
- }
- else
- {
- $aLockInfo = iTopOwnershipLock::AcquireLock($sClass, $iKey);
- if ($aLockInfo['success'])
- {
- $sOwnershipToken = $aLockInfo['token'];
- $sOwnershipDate = $aLockInfo['acquired'];
- }
- else
- {
- $oOwner = $aLockInfo['lock']->GetOwner();
- // If the object is locked by the current user, it's worth trying again, since
- // the lock may be released by 'onunload' which is called AFTER loading the current page.
- //$bTryAgain = $oOwner->GetKey() == UserRights::GetUserId();
- self::ReloadAndDisplay($oPage, $this, array('operation' => 'modify'));
- return;
- }
- }
- }
- }
-
- if (isset($aExtraParams['wizard_container']) && $aExtraParams['wizard_container'])
- {
- $sClassLabel = MetaModel::GetName($sClass);
- $oPage->set_title(Dict::Format('UI:ModificationPageTitle_Object_Class', $this->GetRawName(), $sClassLabel)); // Set title will take care of the encoding
- $oPage->add("<div class=\"page_header\">\n");
- $oPage->add("<h1>".$this->GetIcon()." ".Dict::Format('UI:ModificationTitle_Class_Object', $sClassLabel, $this->GetName())."</h1>\n");
- $oPage->add("</div>\n");
- $oPage->add("<div class=\"wizContainer\">\n");
- }
- self::$iGlobalFormId++;
- $this->aFieldsMap = array();
- $sPrefix = '';
- if (isset($aExtraParams['formPrefix']))
- {
- $sPrefix = $aExtraParams['formPrefix'];
- }
- $aFieldsComments = (isset($aExtraParams['fieldsComments'])) ? $aExtraParams['fieldsComments'] : array();
-
- $this->m_iFormId = $sPrefix.self::$iGlobalFormId;
- $oAppContext = new ApplicationContext();
- $sStateAttCode = MetaModel::GetStateAttributeCode($sClass);
- $aDetails = array();
- $aFieldsMap = array();
- if (!isset($aExtraParams['action']))
- {
- $sFormAction = utils::GetAbsoluteUrlAppRoot().'pages/'.$this->GetUIPage(); // No parameter in the URL, the only parameter will be the ones passed through the form
- }
- else
- {
- $sFormAction = $aExtraParams['action'];
- }
- // Custom label for the apply button ?
- if (isset($aExtraParams['custom_button']))
- {
- $sApplyButton = $aExtraParams['custom_button'];
- }
- else if ($iKey > 0)
- {
- $sApplyButton = Dict::S('UI:Button:Apply');
- }
- else
- {
- $sApplyButton = Dict::S('UI:Button:Create');
- }
- // Custom operation for the form ?
- if (isset($aExtraParams['custom_operation']))
- {
- $sOperation = $aExtraParams['custom_operation'];
- }
- else if ($iKey > 0)
- {
- $sOperation = 'apply_modify';
- }
- else
- {
- $sOperation = 'apply_new';
- }
- if ($iKey > 0)
- {
- // The object already exists in the database, it's a modification
- $sButtons = "<input id=\"{$sPrefix}_id\" type=\"hidden\" name=\"id\" value=\"$iKey\">\n";
- $sButtons .= "<input type=\"hidden\" name=\"operation\" value=\"{$sOperation}\">\n";
- $sButtons .= "<button type=\"button\" class=\"action cancel\"><span>".Dict::S('UI:Button:Cancel')."</span></button> \n";
- $sButtons .= "<button type=\"submit\" class=\"action\"><span>{$sApplyButton}</span></button>\n";
- }
- else
- {
- // The object does not exist in the database it's a creation
- $sButtons = "<input type=\"hidden\" name=\"operation\" value=\"$sOperation\">\n";
- $sButtons .= "<button type=\"button\" class=\"action cancel\">".Dict::S('UI:Button:Cancel')."</button> \n";
- $sButtons .= "<button type=\"submit\" class=\"action\"><span>{$sApplyButton}</span></button>\n";
- }
- $aTransitions = $this->EnumTransitions();
- if (!isset($aExtraParams['custom_operation']) && count($aTransitions))
- {
- // transitions are displayed only for the standard new/modify actions, not for modify_all or any other case...
- $oSetToCheckRights = DBObjectSet::FromObject($this);
- $aStimuli = Metamodel::EnumStimuli($sClass);
- foreach($aTransitions as $sStimulusCode => $aTransitionDef)
- {
- $iActionAllowed = (get_class($aStimuli[$sStimulusCode]) == 'StimulusUserAction') ? UserRights::IsStimulusAllowed($sClass, $sStimulusCode, $oSetToCheckRights) : UR_ALLOWED_NO;
- switch($iActionAllowed)
- {
- case UR_ALLOWED_YES:
- $sButtons .= "<button type=\"submit\" name=\"next_action\" value=\"{$sStimulusCode}\" class=\"action\"><span>".$aStimuli[$sStimulusCode]->GetLabel()."</span></button>\n";
- break;
-
- default:
- // Do nothing
- }
- }
- }
-
- $sButtonsPosition = MetaModel::GetConfig()->Get('buttons_position');
- $iTransactionId = isset($aExtraParams['transaction_id']) ? $aExtraParams['transaction_id'] : utils::GetNewTransactionId();
- $oPage->SetTransactionId($iTransactionId);
- $oPage->add("<form action=\"$sFormAction\" id=\"form_{$this->m_iFormId}\" enctype=\"multipart/form-data\" method=\"post\" onSubmit=\"return OnSubmit('form_{$this->m_iFormId}');\">\n");
- $sStatesSelection = '';
- if (!isset($aExtraParams['custom_operation']) && $this->IsNew())
- {
- $aInitialStates = MetaModel::EnumInitialStates($sClass);
- //$aInitialStates = array('new' => 'foo', 'closed' => 'bar');
- if (count($aInitialStates) > 1)
- {
- $sStatesSelection = Dict::Format('UI:Create_Class_InState', MetaModel::GetName($sClass)).'<select name="obj_state" class="state_select_'.$this->m_iFormId.'">';
- foreach($aInitialStates as $sStateCode => $sStateData)
- {
- $sSelected = '';
- if ($sStateCode == $this->GetState())
- {
- $sSelected = ' selected';
- }
- $sStatesSelection .= '<option value="'.$sStateCode.'"'.$sSelected.'>'.MetaModel::GetStateLabel($sClass, $sStateCode).'</option>';
- }
- $sStatesSelection .= '</select>';
- $oPage->add_ready_script("$('.state_select_{$this->m_iFormId}').change( function() { oWizardHelper$sPrefix.ReloadObjectCreationForm('form_{$this->m_iFormId}', $(this).val()); } );");
- }
- }
- $sConfirmationMessage = addslashes(Dict::S('UI:NavigateAwayConfirmationMessage'));
- $sJSToken = json_encode($sOwnershipToken);
- $oPage->add_ready_script(
- <<<EOF
- $(window).unload(function() { return OnUnload('$iTransactionId', '$sClass', $iKey, $sJSToken) } );
- window.onbeforeunload = function() {
- if (!window.bInSubmit && !window.bInCancel)
- {
- return '$sConfirmationMessage';
- }
- // return nothing ! safer for IE
- };
- EOF
- );
- if ($sButtonsPosition != 'bottom')
- {
- // top or both, display the buttons here
- $oPage->p($sStatesSelection);
- $oPage->add($sButtons);
- }
- $oPage->AddTabContainer(OBJECT_PROPERTIES_TAB, $sPrefix);
- $oPage->SetCurrentTabContainer(OBJECT_PROPERTIES_TAB);
- $oPage->SetCurrentTab(Dict::S('UI:PropertiesTab'));
- $aFieldsMap = $this->DisplayBareProperties($oPage, true, $sPrefix, $aExtraParams);
- if ($iKey > 0)
- {
- $aFieldsMap['id'] = $sPrefix.'_id';
- }
- // Now display the relations, one tab per relation
- if (!isset($aExtraParams['noRelations']))
- {
- $this->DisplayBareRelations($oPage, true); // Edit mode, will fill $this->aFieldsMap
- $aFieldsMap = array_merge($aFieldsMap, $this->aFieldsMap);
- }
- $oPage->SetCurrentTab('');
- $oPage->add("<input type=\"hidden\" name=\"class\" value=\"$sClass\">\n");
- $oPage->add("<input type=\"hidden\" name=\"transaction_id\" value=\"$iTransactionId\">\n");
- foreach($aExtraParams as $sName => $value)
- {
- if (is_scalar($value))
- {
- $oPage->add("<input type=\"hidden\" name=\"$sName\" value=\"$value\">\n");
- }
- }
- if ($sOwnershipToken !== null)
- {
- $oPage->add("<input type=\"hidden\" name=\"ownership_token\" value=\"".htmlentities($sOwnershipToken, ENT_QUOTES, 'UTF-8')."\">\n");
- }
- $oPage->add($oAppContext->GetForForm());
- if ($sButtonsPosition != 'top')
- {
- // bottom or both: display the buttons here
- $oPage->p($sStatesSelection);
- $oPage->add($sButtons);
- }
- // Hook the cancel button via jQuery so that it can be unhooked easily as well if needed
- $sDefaultUrl = utils::GetAbsoluteUrlAppRoot().'pages/UI.php?operation=cancel&'.$oAppContext->GetForLink();
- $oPage->add_ready_script("$('#form_{$this->m_iFormId} button.cancel').click( function() { BackToDetails('$sClass', $iKey, '$sDefaultUrl', $sJSToken)} );");
- $oPage->add("</form>\n");
-
- if (isset($aExtraParams['wizard_container']) && $aExtraParams['wizard_container'])
- {
- $oPage->add("</div>\n");
- }
-
- $iFieldsCount = count($aFieldsMap);
- $sJsonFieldsMap = json_encode($aFieldsMap);
- $sState = $this->GetState();
- $sSessionStorageKey = $sClass.'_'.$iKey;
- $sTempId = session_id().'_'.$iTransactionId;
- $oPage->add_ready_script(InlineImage::EnableCKEditorImageUpload($this, $sTempId));
-
- $oPage->add_script(
- <<<EOF
- sessionStorage.removeItem('$sSessionStorageKey');
-
- // Create the object once at the beginning of the page...
- var oWizardHelper$sPrefix = new WizardHelper('$sClass', '$sPrefix', '$sState');
- oWizardHelper$sPrefix.SetFieldsMap($sJsonFieldsMap);
- oWizardHelper$sPrefix.SetFieldsCount($iFieldsCount);
- EOF
- );
- $oPage->add_ready_script(
- <<<EOF
- oWizardHelper$sPrefix.UpdateWizard();
- // Starts the validation when the page is ready
- CheckFields('form_{$this->m_iFormId}', false);
- EOF
- );
- if ($sOwnershipToken !== null)
- {
- $this->GetOwnershipJSHandler($oPage, $sOwnershipToken);
- }
- else
- {
- // Probably a new object (or no concurrent lock), let's add a watchdog so that the session is kept open while editing
- $iInterval = MetaModel::GetConfig()->Get('concurrent_lock_expiration_delay') * 1000 / 2;
- if ($iInterval > 0)
- {
- $iInterval = max(MIN_WATCHDOG_INTERVAL*1000, $iInterval); // Minimum interval for the watchdog is MIN_WATCHDOG_INTERVAL
- $oPage->add_ready_script(
- <<<EOF
- window.setInterval(function() {
- $.post(GetAbsoluteUrlAppRoot()+'pages/ajax.render.php', {operation: 'watchdog'});
- }, $iInterval);
- EOF
- );
- }
- }
- }
- public static function DisplayCreationForm(WebPage $oPage, $sClass, $oObjectToClone = null, $aArgs = array(), $aExtraParams = array())
- {
- $oAppContext = new ApplicationContext();
- $sClass = ($oObjectToClone == null) ? $sClass : get_class($oObjectToClone);
- $sStateAttCode = MetaModel::GetStateAttributeCode($sClass);
- $aStates = MetaModel::EnumStates($sClass);
- $sStatesSelection = '';
-
- if ($oObjectToClone == null)
- {
- $oObj = MetaModel::NewObject($sClass);
- if (!empty($sStateAttCode))
- {
- $sTargetState = MetaModel::GetDefaultState($sClass);
- $oObj->Set($sStateAttCode, $sTargetState);
- }
- }
- else
- {
- $oObj = clone $oObjectToClone;
- }
- // Pre-fill the object with default values, when there is only on possible choice
- // AND the field is mandatory (otherwise there is always the possiblity to let it empty)
- $aArgs['this'] = $oObj;
- $aDetailsList = self::FLattenZList(MetaModel::GetZListItems($sClass, 'details'));
- // Order the fields based on their dependencies
- $aDeps = array();
- foreach($aDetailsList as $sAttCode)
- {
- $aDeps[$sAttCode] = MetaModel::GetPrerequisiteAttributes($sClass, $sAttCode);
- }
- $aList = self::OrderDependentFields($aDeps);
-
- // Now fill-in the fields with default/supplied values
- foreach($aList as $sAttCode)
- {
- if (isset($aArgs['default'][$sAttCode]))
- {
- $oObj->Set($sAttCode, $aArgs['default'][$sAttCode]);
- }
- else
- {
- $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
- // If the field is mandatory, set it to the only possible value
- $iFlags = $oObj->GetInitialStateAttributeFlags($sAttCode);
- if ((!$oAttDef->IsNullAllowed()) || ($iFlags & OPT_ATT_MANDATORY))
- {
- if ($oAttDef->IsExternalKey())
- {
- $oAllowedValues = MetaModel::GetAllowedValuesAsObjectSet($sClass, $sAttCode, $aArgs);
- if ($oAllowedValues->Count() == 1)
- {
- $oRemoteObj = $oAllowedValues->Fetch();
- $oObj->Set($sAttCode, $oRemoteObj->GetKey());
- }
- }
- else
- {
- $aAllowedValues = MetaModel::GetAllowedValues_att($sClass, $sAttCode, $aArgs);
- if (count($aAllowedValues) == 1)
- {
- $aValues = array_keys($aAllowedValues);
- $oObj->Set($sAttCode, $aValues[0]);
- }
- }
- }
- }
- }
- return $oObj->DisplayModifyForm( $oPage, $aExtraParams);
- }
-
- public function DisplayStimulusForm(WebPage $oPage, $sStimulus)
- {
- $sClass = get_class($this);
- $iKey = $this->GetKey();
- $aTransitions = $this->EnumTransitions();
- $aStimuli = MetaModel::EnumStimuli($sClass);
- if (!isset($aTransitions[$sStimulus]))
- {
- // Invalid stimulus
- throw new ApplicationException(Dict::Format('UI:Error:Invalid_Stimulus_On_Object_In_State', $sStimulus, $this->GetName(), $this->GetStateLabel()));
- }
- // Check for concurrent access lock
- $LockEnabled = MetaModel::GetConfig()->Get('concurrent_lock_enabled');
- $sOwnershipToken = null;
- if ($LockEnabled)
- {
- $sOwnershipToken = utils::ReadPostedParam('ownership_token', null, false, 'raw_data');
- $aLockInfo = iTopOwnershipLock::AcquireLock($sClass, $iKey);
- if ($aLockInfo['success'])
- {
- $sOwnershipToken = $aLockInfo['token'];
- $sOwnershipDate = $aLockInfo['acquired'];
- }
- else
- {
- $oOwner = $aLockInfo['lock']->GetOwner();
- // If the object is locked by the current user, it's worth trying again, since
- // the lock may be released by 'onunload' which is called AFTER loading the current page.
- //$bTryAgain = $oOwner->GetKey() == UserRights::GetUserId();
- self::ReloadAndDisplay($oPage, $this, array('operation' => 'stimulus', 'stimulus' => $sStimulus));
- return;
- }
- }
- $sActionLabel = $aStimuli[$sStimulus]->GetLabel();
- $sActionDetails = $aStimuli[$sStimulus]->GetDescription();
- $aTransition = $aTransitions[$sStimulus];
- $sTargetState = $aTransition['target_state'];
- $aTargetStates = MetaModel::EnumStates($sClass);
- $oPage->add("<div class=\"page_header\">\n");
- $oPage->add("<h1>$sActionLabel - <span class=\"hilite\">{$this->GetName()}</span></h1>\n");
- $oPage->set_title($sActionLabel);
- $oPage->add("</div>\n");
- $aTargetState = $aTargetStates[$sTargetState];
- $aExpectedAttributes = $aTargetState['attribute_list'];
- $oPage->add("<h1>$sActionDetails</h1>\n");
- $sButtonsPosition = MetaModel::GetConfig()->Get('buttons_position');
- if ($sButtonsPosition == 'bottom')
- {
- // bottom: Displays the ticket details BEFORE the actions
- $oPage->add('<div class="ui-widget-content">');
- $this->DisplayBareProperties($oPage);
- $oPage->add('</div>');
- }
- $oPage->add("<div class=\"wizContainer\">\n");
- $oPage->add("<form id=\"apply_stimulus\" method=\"post\" onSubmit=\"return OnSubmit('apply_stimulus');\">\n");
- $aDetails = array();
- $iFieldIndex = 0;
- $aFieldsMap = array();
- // The list of candidate fields is made of the ordered list of "details" attributes + other attributes
- $aAttributes = array();
- foreach ($this->FlattenZList(MetaModel::GetZListItems($sClass, 'details')) as $sAttCode)
- {
- $aAttributes[$sAttCode] = true;
- }
- foreach(MetaModel::GetAttributesList($sClass) as $sAttCode)
- {
- if (!array_key_exists($sAttCode, $aAttributes))
- {
- $aAttributes[$sAttCode] = true;
- }
- }
- // Order the fields based on their dependencies, set the fields for which there is only one possible value
- // and perform this in the order of dependencies to avoid dead-ends
- $aDeps = array();
- foreach($aAttributes as $sAttCode => $trash)
- {
- $aDeps[$sAttCode] = MetaModel::GetPrerequisiteAttributes($sClass, $sAttCode);
- }
- $aList = $this->OrderDependentFields($aDeps);
- foreach($aList as $sAttCode)
- {
- // Consider only the "expected" fields for the target state
- if (array_key_exists($sAttCode, $aExpectedAttributes))
- {
- $iExpectCode = $aExpectedAttributes[$sAttCode];
- // Prompt for an attribute if
- // - the attribute must be changed or must be displayed to the user for confirmation
- // - or the field is mandatory and currently empty
- if ( ($iExpectCode & (OPT_ATT_MUSTCHANGE | OPT_ATT_MUSTPROMPT)) ||
- (($iExpectCode & OPT_ATT_MANDATORY) && ($this->Get($sAttCode) == '')) )
- {
- $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
- $aArgs = array('this' => $this);
- // If the field is mandatory, set it to the only possible value
- if ((!$oAttDef->IsNullAllowed()) || ($iExpectCode & OPT_ATT_MANDATORY))
- {
- if ($oAttDef->IsExternalKey())
- {
- $oAllowedValues = MetaModel::GetAllowedValuesAsObjectSet($sClass, $sAttCode, $aArgs);
- if ($oAllowedValues->Count() == 1)
- {
- $oRemoteObj = $oAllowedValues->Fetch();
- $this->Set($sAttCode, $oRemoteObj->GetKey());
- }
- }
- else
- {
- $aAllowedValues = MetaModel::GetAllowedValues_att($sClass, $sAttCode, $aArgs);
- if (count($aAllowedValues) == 1)
- {
- $aValues = array_keys($aAllowedValues);
- $this->Set($sAttCode, $aValues[0]);
- }
- }
- }
- $sHTMLValue = cmdbAbstractObject::GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef,$this->Get($sAttCode),$this->GetEditValue($sAttCode), 'att_'.$iFieldIndex, '', $iExpectCode, $aArgs);
- $aDetails[] = array('label' => '<span>'.$oAttDef->GetLabel().'</span>', 'value' => "<span id=\"field_att_$iFieldIndex\">$sHTMLValue</span>");
- $aFieldsMap[$sAttCode] = 'att_'.$iFieldIndex;
- $iFieldIndex++;
- }
- }
- }
- $oPage->add('<table><tr><td>');
- $oPage->details($aDetails);
- $oPage->add('</td></tr></table>');
- $oPage->add("<input type=\"hidden\" name=\"id\" value=\"".$this->GetKey()."\" id=\"id\">\n");
- $aFieldsMap['id'] = 'id';
- $oPage->add("<input type=\"hidden\" name=\"class\" value=\"$sClass\">\n");
- $oPage->add("<input type=\"hidden\" name=\"operation\" value=\"apply_stimulus\">\n");
- $oPage->add("<input type=\"hidden\" name=\"stimulus\" value=\"$sStimulus\">\n");
- $iTransactionId = utils::GetNewTransactionId();
- $oPage->add("<input type=\"hidden\" name=\"transaction_id\" value=\"".$iTransactionId."\">\n");
- if ($sOwnershipToken !== null)
- {
- $oPage->add("<input type=\"hidden\" name=\"ownership_token\" value=\"".htmlentities($sOwnershipToken, ENT_QUOTES, 'UTF-8')."\">\n");
- }
- $oAppContext = new ApplicationContext();
- $oPage->add($oAppContext->GetForForm());
- $oPage->add("<button type=\"button\" class=\"action cancel\" onClick=\"BackToDetails('$sClass', ".$this->GetKey().", '', '$sOwnershipToken')\"><span>".Dict::S('UI:Button:Cancel')."</span></button> \n");
- $oPage->add("<button type=\"submit\" class=\"action\"><span>$sActionLabel</span></button>\n");
- $oPage->add("</form>\n");
- $oPage->add("</div>\n");
- if ($sButtonsPosition != 'top')
- {
- // bottom or both: Displays the ticket details AFTER the actions
- $oPage->add('<div class="ui-widget-content">');
- $this->DisplayBareProperties($oPage);
- $oPage->add('</div>');
- }
- $iFieldsCount = count($aFieldsMap);
- $sJsonFieldsMap = json_encode($aFieldsMap);
- $oPage->add_script(
- <<<EOF
- // Initializes the object once at the beginning of the page...
- var oWizardHelper = new WizardHelper('$sClass', '', '$sTargetState');
- oWizardHelper.SetFieldsMap($sJsonFieldsMap);
- oWizardHelper.SetFieldsCount($iFieldsCount);
- EOF
- );
- $sJSToken = json_encode($sOwnershipToken);
- $oPage->add_ready_script(
- <<<EOF
- // Starts the validation when the page is ready
- CheckFields('apply_stimulus', false);
- $(window).unload(function() { return OnUnload('$iTransactionId', '$sClass', $iKey, $sJSToken) } );
- EOF
- );
-
- if ($sOwnershipToken !== null)
- {
- $this->GetOwnershipJSHandler($oPage, $sOwnershipToken);
- }
- }
- public static function ProcessZlist($aList, $aDetails, $sCurrentTab, $sCurrentCol, $sCurrentSet)
- {
- //echo "<pre>ZList: ";
- //print_r($aList);
- //echo "</pre>\n";
- $index = 0;
- foreach($aList as $sKey => $value)
- {
- if (is_array($value))
- {
- if (preg_match('/^(.*):(.*)$/U', $sKey, $aMatches))
- {
- $sCode = $aMatches[1];
- $sName = $aMatches[2];
- switch($sCode)
- {
- case 'tab':
- //echo "<p>Found a tab: $sName ($sKey)</p>\n";
- if(!isset($aDetails[$sName]))
- {
- $aDetails[$sName] = array('col1' => array());
- }
- $aDetails = self::ProcessZlist($value, $aDetails, $sName, 'col1', '');
- break;
-
- case 'fieldset':
- //echo "<p>Found a fieldset: $sName ($sKey)</p>\n";
- if(!isset($aDetailsStruct[$sCurrentTab][$sCurrentCol][$sName]))
- {
- $aDetails[$sCurrentTab][$sCurrentCol][$sName] = array();
- }
- $aDetails = self::ProcessZlist($value, $aDetails, $sCurrentTab, $sCurrentCol, $sName);
- break;
- default:
- case 'col':
- //echo "<p>Found a column: $sName ($sKey)</p>\n";
- if(!isset($aDetails[$sCurrentTab][$sName]))
- {
- $aDetails[$sCurrentTab][$sName] = array();
- }
- $aDetails = self::ProcessZlist($value, $aDetails, $sCurrentTab, $sName, '');
- break;
- }
- }
- }
- else
- {
- //echo "<p>Scalar value: $value, in [$sCurrentTab][$sCurrentCol][$sCurrentSet][]</p>\n";
- if (empty($sCurrentSet))
- {
- $aDetails[$sCurrentTab][$sCurrentCol]['_'.$index][] = $value;
- }
- else
- {
- $aDetails[$sCurrentTab][$sCurrentCol][$sCurrentSet][] = $value;
- }
- }
- $index++;
- }
- return $aDetails;
- }
- static function FlattenZList($aList)
- {
- $aResult = array();
- foreach($aList as $value)
- {
- if (!is_array($value))
- {
- $aResult[] = $value;
- }
- else
- {
- $aResult = array_merge($aResult,self::FlattenZList($value));
- }
- }
- return $aResult;
- }
-
- protected function GetFieldAsHtml($sClass, $sAttCode, $sStateAttCode)
- {
- $retVal = null;
- if ($this->IsNew())
- {
- $iFlags = $this->GetInitialStateAttributeFlags($sAttCode);
- }
- else
- {
- $iFlags = $this->GetAttributeFlags($sAttCode);
- }
- $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
- if ( (!$oAttDef->IsLinkSet()) && (($iFlags & OPT_ATT_HIDDEN) == 0) )
- {
- // The field is visible in the current state of the object
- if ($sStateAttCode == $sAttCode)
- {
- // Special display for the 'state' attribute itself
- $sDisplayValue = $this->GetStateLabel();
- }
- else if ($oAttDef->GetEditClass() == 'Document')
- {
- $oDocument = $this->Get($sAttCode);
- $sDisplayValue = $this->GetAsHTML($sAttCode);
- $sDisplayValue .= "<br/>".Dict::Format('UI:OpenDocumentInNewWindow_', $oDocument->GetDisplayLink(get_class($this), $this->GetKey(), $sAttCode)).", \n";
- $sDisplayValue .= "<br/>".Dict::Format('UI:DownloadDocument_', $oDocument->GetDownloadLink(get_class($this), $this->GetKey(), $sAttCode)).", \n";
- }
- else
- {
- $sDisplayValue = $this->GetAsHTML($sAttCode);
- }
- $retVal = array('label' => '<span title="'.MetaModel::GetDescription($sClass, $sAttCode).'">'.MetaModel::GetLabel($sClass, $sAttCode).'</span>', 'value' => $sDisplayValue);
- }
- return $retVal;
- }
-
- /**
- * Displays a blob document *inline* (if possible, depending on the type of the document)
- * @return string
- */
- public function DisplayDocumentInline(WebPage $oPage, $sAttCode)
- {
- $oDoc = $this->Get($sAttCode);
- $sClass = get_class($this);
- $Id = $this->GetKey();
- switch ($oDoc->GetMainMimeType())
- {
- case 'text':
- case 'html':
- $data = $oDoc->GetData();
- switch($oDoc->GetMimeType())
- {
- case 'text/html':
- case 'text/xml':
- $oPage->add("<iframe id='preview_$sAttCode' src=\"".utils::GetAbsoluteUrlAppRoot()."pages/ajax.render.php?operation=display_document&class=$sClass&id=$Id&field=$sAttCode\" width=\"100%\" height=\"400\">Loading...</iframe>\n");
- break;
-
- default:
- $oPage->add("<pre>".htmlentities(MyHelpers::beautifulstr($data, 1000, true), ENT_QUOTES, 'UTF-8')."</pre>\n");
- }
- break;
- case 'application':
- switch($oDoc->GetMimeType())
- {
- case 'application/pdf':
- $oPage->add("<iframe id='preview_$sAttCode' src=\"".utils::GetAbsoluteUrlAppRoot()."pages/ajax.render.php?operation=display_document&class=$sClass&id=$Id&field=$sAttCode\" width=\"100%\" height=\"400\">Loading...</iframe>\n");
- break;
- default:
- $oPage->add(Dict::S('UI:Document:NoPreview'));
- }
- break;
-
- case 'image':
- $oPage->add("<img src=\"".utils::GetAbsoluteUrlAppRoot()."pages/ajax.render.php?operation=display_document&class=$sClass&id=$Id&field=$sAttCode\" />\n");
- break;
-
- default:
- $oPage->add(Dict::S('UI:Document:NoPreview'));
- }
- }
-
- // $m_highlightComparison[previous][new] => next value
- protected static $m_highlightComparison = array(
- HILIGHT_CLASS_CRITICAL => array(
- HILIGHT_CLASS_CRITICAL => HILIGHT_CLASS_CRITICAL,
- HILIGHT_CLASS_WARNING => HILIGHT_CLASS_CRITICAL,
- HILIGHT_CLASS_OK => HILIGHT_CLASS_CRITICAL,
- HILIGHT_CLASS_NONE => HILIGHT_CLASS_CRITICAL,
- ),
- HILIGHT_CLASS_WARNING => array(
- HILIGHT_CLASS_CRITICAL => HILIGHT_CLASS_CRITICAL,
- HILIGHT_CLASS_WARNING => HILIGHT_CLASS_WARNING,
- HILIGHT_CLASS_OK => HILIGHT_CLASS_WARNING,
- HILIGHT_CLASS_NONE => HILIGHT_CLASS_WARNING,
- ),
- HILIGHT_CLASS_OK => array(
- HILIGHT_CLASS_CRITICAL => HILIGHT_CLASS_CRITICAL,
- HILIGHT_CLASS_WARNING => HILIGHT_CLASS_WARNING,
- HILIGHT_CLASS_OK => HILIGHT_CLASS_OK,
- HILIGHT_CLASS_NONE => HILIGHT_CLASS_OK,
- ),
- HILIGHT_CLASS_NONE => array(
- HILIGHT_CLASS_CRITICAL => HILIGHT_CLASS_CRITICAL,
- HILIGHT_CLASS_WARNING => HILIGHT_CLASS_WARNING,
- HILIGHT_CLASS_OK => HILIGHT_CLASS_OK,
- HILIGHT_CLASS_NONE => HILIGHT_CLASS_NONE,
- ),
- );
-
- /**
- * This function returns a 'hilight' CSS class, used to hilight a given row in a table
- * There are currently (i.e defined in the CSS) 4 possible values HILIGHT_CLASS_CRITICAL,
- * HILIGHT_CLASS_WARNING, HILIGHT_CLASS_OK, HILIGHT_CLASS_NONE
- * To Be overridden by derived classes
- * @param void
- * @return String The desired higlight class for the object/row
- */
- public function GetHilightClass()
- {
- // Possible return values are:
- // HILIGHT_CLASS_CRITICAL, HILIGHT_CLASS_WARNING, HILIGHT_CLASS_OK, HILIGHT_CLASS_NONE
- $current = parent::GetHilightClass(); // Default computation
- // Invoke extensions before the deletion (the deletion will do some cleanup and we might loose some information
- foreach (MetaModel::EnumPlugins('iApplicationUIExtension') as $oExtensionInstance)
- {
- $new = $oExtensionInstance->GetHilightClass($this);
- @$current = self::$m_highlightComparison[$current][$new];
- }
- return $current;
- }
-
- /**
- * Re-order the fields based on their inter-dependencies
- * @params hash @aFields field_code => array_of_depencies
- * @return array Ordered array of fields or throws an exception
- */
- public static function OrderDependentFields($aFields)
- {
- $bCircular = false;
- $aResult = array();
- $iCount = 0;
- do
- {
- $bSet = false;
- $iCount++;
- foreach($aFields as $sFieldCode => $aDeps)
- {
- foreach($aDeps as $key => $sDependency)
- {
- if (in_array($sDependency, $aResult))
- {
- // Dependency is resolved, remove it
- unset($aFields[$sFieldCode][$key]);
- }
- else if (!array_key_exists($sDependency, $aFields))
- {
- // The current fields depends on a field not present in the form
- // let's ignore it (since it cannot change)
- unset($aFields[$sFieldCode][$key]);
- }
- }
- if (count($aFields[$sFieldCode]) == 0)
- {
- // No more pending depencies for this field, add it to the list
- $aResult[] = $sFieldCode;
- unset($aFields[$sFieldCode]);
- $bSet = true;
- }
- }
- }
- while($bSet && (count($aFields) > 0));
-
- if (count($aFields) > 0)
- {
- $sMessage = "Error: Circular dependencies between the fields! <pre>".print_r($aFields, true)."</pre>";
- throw(new Exception($sMessage));
- }
- return $aResult;
- }
-
- /**
- * Get the list of actions to be displayed as 'shortcuts' (i.e buttons) instead of inside the Actions popup menu
- * @param $sFinalClass string The actual class of the objects for which to display the menu
- * @return Array the list of menu codes (i.e dictionary entries) that can be displayed as shortcuts next to the actions menu
- */
- public static function GetShortcutActions($sFinalClass)
- {
- $sShortcutActions = MetaModel::GetConfig()->Get('shortcut_actions');
- $aShortcutActions = explode(',', $sShortcutActions);
- return $aShortcutActions;
- }
-
- /**
- * Maps the given context parameter name to the appropriate filter/search code for this class
- * @param string $sContextParam Name of the context parameter, i.e. 'org_id'
- * @return string Filter code, i.e. 'customer_id'
- */
- public static function MapContextParam($sContextParam)
- {
- if ($sContextParam == 'menu')
- {
- return null;
- }
- else
- {
- return $sContextParam;
- }
- }
-
- /**
- * Updates the object from a flat array of values
- * @param $aAttList array $aAttList array of attcode
- * @param $aErrors array Returns information about slave attributes
- * @param $sTargetState string Target state for which to evaluate the writeable attributes (=current state is empty)
- * @return array of attcodes that can be used for writing on the current object
- */
- public function GetWriteableAttList($aAttList, &$aErrors, $sTargetState = '')
- {
- if (!is_array($aAttList))
- {
- $aAttList = $this->FlattenZList(MetaModel::GetZListItems(get_class($this), 'details'));
- // Special case to process the case log, if any...
- // WARNING: if you change this also check the functions DisplayModifyForm and DisplayCaseLog
- foreach(MetaModel::ListAttributeDefs(get_class($this)) as $sAttCode => $oAttDef)
- {
- if ($this->IsNew())
- {
- $iFlags = $this->GetInitialStateAttributeFlags($sAttCode);
- }
- else
- {
- $aVoid = array();
- $iFlags = $this->GetAttributeFlags($sAttCode, $aVoid, $sTargetState);
- }
- if ($oAttDef instanceof AttributeCaseLog)
- {
- if (!($iFlags & (OPT_ATT_HIDDEN|OPT_ATT_SLAVE|OPT_ATT_READONLY)))
- {
- // The case log is editable, append it to the list of fields to retrieve
- $aAttList[] = $sAttCode;
- }
- }
- }
- }
- $aWriteableAttList = array();
- foreach($aAttList as $sAttCode)
- {
- $oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
-
- if ($this->IsNew())
- {
- $iFlags = $this->GetInitialStateAttributeFlags($sAttCode);
- }
- else
- {
- $aVoid = array();
- $iFlags = $this->GetAttributeFlags($sAttCode, $aVoid, $sTargetState);
- }
- if ($oAttDef->IsWritable())
- {
- if ( $iFlags & (OPT_ATT_HIDDEN | OPT_ATT_READONLY))
- {
- // Non-visible, or read-only attribute, do nothing
- }
- elseif($iFlags & OPT_ATT_SLAVE)
- {
- $aErrors[$sAttCode] = Dict::Format('UI:AttemptingToSetASlaveAttribute_Name', $oAttDef->GetLabel());
- }
- else
- {
- $aWriteableAttList[$sAttCode] = $oAttDef;
- }
- }
- }
- return $aWriteableAttList;
- }
- /**
- * Compute the attribute flags depending on the object state
- */
- public function GetFormAttributeFlags($sAttCode)
- {
- if ($this->IsNew())
- {
- $iFlags = $this->GetInitialStateAttributeFlags($sAttCode);
- }
- else
- {
- $iFlags = $this->GetAttributeFlags($sAttCode);
- }
- if (($iFlags & OPT_ATT_MANDATORY) && $this->IsNew())
- {
- $iFlags = $iFlags & ~OPT_ATT_READONLY; // Mandatory fields cannot be read-only when creating an object
- }
- return $iFlags;
- }
- /**
- * Updates the object from a flat array of values
- * @param string $aValues array of attcode => scalar or array (N-N links)
- * @return void
- */
- public function UpdateObjectFromArray($aValues)
- {
- foreach($aValues as $sAttCode => $value)
- {
- $oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
- if ($oAttDef->IsLinkSet() && $oAttDef->IsIndirect())
- {
- $aLinks = $value;
- $sLinkedClass = $oAttDef->GetLinkedClass();
- $sExtKeyToRemote = $oAttDef->GetExtKeyToRemote();
- $sExtKeyToMe = $oAttDef->GetExtKeyToMe();
- $oLinkedSet = DBObjectSet::FromScratch($sLinkedClass);
- if (is_array($aLinks))
- {
- foreach($aLinks as $id => $aData)
- {
- if (is_numeric($id))
- {
- if ($id < 0)
- {
- // New link to be created, the opposite of the id (-$id) is the ID of the remote object
- $oLink = MetaModel::NewObject($sLinkedClass);
- $oLink->Set($sExtKeyToRemote, -$id);
- $oLink->Set($sExtKeyToMe, $this->GetKey());
- }
- else
- {
- // Existing link, potentially to be updated...
- $oLink = MetaModel::GetObject($sLinkedClass, $id);
- }
- // Now populate the attributes
- foreach($aData as $sName => $value)
- {
- if (MetaModel::IsValidAttCode($sLinkedClass, $sName))
- {
- $oLinkAttDef = MetaModel::GetAttributeDef($sLinkedClass, $sName);
- if ($oLinkAttDef->IsWritable())
- {
- $oLink->Set($sName, $value);
- }
- }
- }
- $oLinkedSet->AddObject($oLink);
- }
- }
- }
- $this->Set($sAttCode, $oLinkedSet);
- }
- elseif ($oAttDef->GetEditClass() == 'Document')
- {
- // There should be an uploaded file with the named attr_<attCode>
- $oDocument = $value['fcontents'];
- if (!$oDocument->IsEmpty())
- {
- // A new file has been uploaded
- $this->Set($sAttCode, $oDocument);
- }
- }
- elseif ($oAttDef->GetEditClass() == 'One Way Password')
- {
- // Check if the password was typed/changed
- $aPwdData = $value;
- if (!is_null($aPwdData) && $aPwdData['changed'])
- {
- // The password has been changed or set
- $this->Set($sAttCode, $aPwdData['value']);
- }
- }
- elseif ($oAttDef->GetEditClass() == 'Duration')
- {
- $aDurationData = $value;
- if (!is_array($aDurationData)) continue;
- $iValue = (((24*$aDurationData['d'])+$aDurationData['h'])*60 +$aDurationData['m'])*60 + $aDurationData['s'];
- $this->Set($sAttCode, $iValue);
- $previousValue = $this->Get($sAttCode);
- if ($previousValue !== $iValue)
- {
- $this->Set($sAttCode, $iValue);
- }
- }
- elseif ($oAttDef->GetEditClass() == 'CustomFields')
- {
- $this->Set($sAttCode, $value);
- }
- else if (($oAttDef->GetEditClass() == 'LinkedSet') && !$oAttDef->IsIndirect() &&
- (($oAttDef->GetEditMode() == LINKSET_EDITMODE_INPLACE) || ($oAttDef->GetEditMode() == LINKSET_EDITMODE_ADDREMOVE)))
- {
- $oLinkset = $this->Get($sAttCode);
- $sLinkedClass = $oLinkset->GetClass();
- $aObjSet = array();
- $oLinkset->Rewind();
- $bModified = false;
- while($oLink = $oLinkset->Fetch())
- {
- if (in_array($oLink->GetKey(), $value['to_be_deleted']))
- {
- // The link is to be deleted, don't copy it in the array
- $bModified = true;
- }
- else
- {
- if (!array_key_exists('to_be_removed', $value) || !in_array($oLink->GetKey(), $value['to_be_removed']))
- {
- $aObjSet[] = $oLink;
- }
- }
- }
- if (array_key_exists('to_be_created', $value) && (count($value['to_be_created']) > 0))
- {
- // Now handle the links to be created
- foreach($value['to_be_created'] as $aData)
- {
- $sSubClass = $aData['class'];
- if ( ($sLinkedClass == $sSubClass) || (is_subclass_of($sSubClass, $sLinkedClass)) )
- {
- $aObjData = $aData['data'];
-
- $oLink = new $sSubClass;
- $oLink->UpdateObjectFromArray($aObjData);
- $aObjSet[] = $oLink;
- $bModified = true;
- }
- }
- }
- if (array_key_exists('to_be_added', $value) && (count($value['to_be_added']) > 0))
- {
- // Now handle the links to be added by making the remote object point to self
- foreach($value['to_be_added'] as $iObjKey)
- {
- $oLink = MetaModel::GetObject($sLinkedClass, $iObjKey, false);
- if ($oLink)
- {
- $aObjSet[] = $oLink;
- $bModified = true;
- }
- }
- }
- if (array_key_exists('to_be_removed', $value) && (count($value['to_be_removed']) > 0))
- {
- // Now handle the links to be removed by making the remote object point to nothing
- // Keep them in the set (modified), DBWriteLinks will handle them
- foreach($value['to_be_removed'] as $iObjKey)
- {
- $oLink = MetaModel::GetObject($sLinkedClass, $iObjKey, false);
- if ($oLink)
- {
- $sExtKeyToMe = $oAttDef->GetExtKeyToMe();
- $oLink->Set($sExtKeyToMe, null);
- $aObjSet[] = $oLink;
- $bModified = true;
- }
- }
- }
- if ($bModified)
- {
- $oNewSet = DBObjectSet::FromArray($oLinkset->GetClass(), $aObjSet);
- $this->Set($sAttCode, $oNewSet);
- }
- }
- else
- {
- if (!is_null($value))
- {
- $aAttributes[$sAttCode] = trim($value);
- $previousValue = $this->Get($sAttCode);
- if ($previousValue !== $aAttributes[$sAttCode])
- {
- $this->Set($sAttCode, $aAttributes[$sAttCode]);
- }
- }
- }
- }
- }
- /**
- * Updates the object from the POSTed parameters (form)
- */
- public function UpdateObjectFromPostedForm($sFormPrefix = '', $aAttList = null, $sTargetState = '')
- {
- if (is_null($aAttList))
- {
- $aAttList = array_keys(MetaModel::ListAttributeDefs(get_class($this)));
- }
- $aValues = array();
- foreach($aAttList as $sAttCode)
- {
- $oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
- if ($oAttDef->GetEditClass() == 'Document')
- {
- $value = array('fcontents' => utils::ReadPostedDocument("attr_{$sFormPrefix}{$sAttCode}", 'fcontents'));
- }
- elseif ($oAttDef->GetEditClass() == 'RedundancySetting')
- {
- $value = $oAttDef->ReadValueFromPostedForm($sFormPrefix);
- }
- elseif ($oAttDef->GetEditClass() == 'CustomFields')
- {
- $value = $oAttDef->ReadValueFromPostedForm($this, $sFormPrefix);
- }
- else if (($oAttDef->GetEditClass() == 'LinkedSet') && !$oAttDef->IsIndirect() &&
- (($oAttDef->GetEditMode() == LINKSET_EDITMODE_INPLACE) || ($oAttDef->GetEditMode() == LINKSET_EDITMODE_ADDREMOVE)) )
- {
- $aRawToBeCreated = json_decode(utils::ReadPostedParam("attr_{$sFormPrefix}{$sAttCode}_tbc", '{}', 'raw_data'), true);
- $aToBeCreated = array();
- foreach($aRawToBeCreated as $aData)
- {
- $sSubFormPrefix = $aData['formPrefix'];
- $sObjClass = $aData['class'];
- $aObjData = array();
- foreach($aData as $sKey => $value)
- {
- if (preg_match("/^attr_$sSubFormPrefix(.*)$/", $sKey, $aMatches))
- {
- $aObjData[$aMatches[1]] = $value;
- }
- }
- $aToBeCreated[] = array('class' => $sObjClass, 'data' => $aObjData);
- }
-
- $value = array('to_be_created' => $aToBeCreated,
- 'to_be_deleted' => json_decode(utils::ReadPostedParam("attr_{$sFormPrefix}{$sAttCode}_tbd", '[]', 'raw_data'), true),
- 'to_be_added' => json_decode(utils::ReadPostedParam("attr_{$sFormPrefix}{$sAttCode}_tba", '[]', 'raw_data'), true),
- 'to_be_removed' => json_decode(utils::ReadPostedParam("attr_{$sFormPrefix}{$sAttCode}_tbr", '[]', 'raw_data'), true) );
- }
- else if ($oAttDef instanceof AttributeDateTime) // AttributeDate is derived from AttributeDateTime
- {
- $value = utils::ReadPostedParam("attr_{$sFormPrefix}{$sAttCode}", null, 'raw_data');
- if ($value != null)
- {
- $oDate = $oAttDef->GetFormat()->Parse($value);
- if ($oDate instanceof DateTime)
- {
- $value = $oDate->format($oAttDef->GetInternalFormat());
- }
- else
- {
- $value = null;
- }
- }
- }
- else
- {
- $value = utils::ReadPostedParam("attr_{$sFormPrefix}{$sAttCode}", null, 'raw_data');
- }
- if (!is_null($value))
- {
- $aValues[$sAttCode] = $value;
- }
- }
- $aErrors = array();
- $aFinalValues = array();
- foreach($this->GetWriteableAttList(array_keys($aValues), $aErrors, $sTargetState) as $sAttCode => $oAttDef)
- {
- $aFinalValues[$sAttCode] = $aValues[$sAttCode];
- }
- $this->UpdateObjectFromArray($aFinalValues);
- if (!$this->IsNew()) // for new objects this is performed in DBInsertNoReload()
- {
- InlineImage::FinalizeInlineImages($this);
- }
-
- // Invoke extensions after the update of the object from the form
- foreach (MetaModel::EnumPlugins('iApplicationUIExtension') as $oExtensionInstance)
- {
- $oExtensionInstance->OnFormSubmit($this, $sFormPrefix);
- }
-
- return $aErrors;
- }
- /**
- * Updates the object from a given page argument
- */
- public function UpdateObjectFromArg($sArgName, $aAttList = null, $sTargetState = '')
- {
- if (is_null($aAttList))
- {
- $aAttList = array_keys(MetaModel::ListAttributeDefs(get_class($this)));
- }
- $aRawValues = utils::ReadParam($sArgName, array(), '', 'raw_data');
- $aValues = array();
- foreach($aAttList as $sAttCode)
- {
- if (isset($aRawValues[$sAttCode]))
- {
- $aValues[$sAttCode] = $aRawValues[$sAttCode];
- }
- }
- $aErrors = array();
- $aFinalValues = array();
- foreach($this->GetWriteableAttList(array_keys($aValues), $aErrors, $sTargetState) as $sAttCode => $oAttDef)
- {
- $aFinalValues[$sAttCode] = $aValues[$sAttCode];
- }
- $this->UpdateObjectFromArray($aFinalValues);
- return $aErrors;
- }
- public function DBInsertNoReload()
- {
- $res = parent::DBInsertNoReload();
- InlineImage::FinalizeInlineImages($this);
-
- // Invoke extensions after insertion (the object must exist, have an id, etc.)
- foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
- {
- $oExtensionInstance->OnDBInsert($this, self::GetCurrentChange());
- }
- return $res;
- }
- protected function DBCloneTracked_Internal($newKey = null)
- {
- $oNewObj = parent::DBCloneTracked_Internal($newKey);
- // Invoke extensions after insertion (the object must exist, have an id, etc.)
- foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
- {
- $oExtensionInstance->OnDBInsert($oNewObj, self::GetCurrentChange());
- }
- return $oNewObj;
- }
- public function DBUpdate()
- {
- $res = parent::DBUpdate();
- // Invoke extensions after the update (could be before)
- foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
- {
- $oExtensionInstance->OnDBUpdate($this, self::GetCurrentChange());
- }
- return $res;
- }
- protected static function BulkUpdateTracked_Internal(DBSearch $oFilter, array $aValues)
- {
- // Todo - invoke the extension
- return parent::BulkUpdateTracked_Internal($oFilter, $aValues);
- }
- protected function DBDeleteTracked_Internal(&$oDeletionPlan = null)
- {
- // Invoke extensions before the deletion (the deletion will do some cleanup and we might loose some information
- foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
- {
- $oExtensionInstance->OnDBDelete($this, self::GetCurrentChange());
- }
- return parent::DBDeleteTracked_Internal($oDeletionPlan);
- }
- public function IsModified()
- {
- if (parent::IsModified())
- {
- return true;
- }
- // Plugins
- //
- foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
- {
- if ($oExtensionInstance->OnIsModified($this))
- {
- return true;
- }
- }
- return false;
- }
- public function DoCheckToWrite()
- {
- parent::DoCheckToWrite();
- // Plugins
- //
- foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
- {
- $aNewIssues = $oExtensionInstance->OnCheckToWrite($this);
- if (count($aNewIssues) > 0)
- {
- $this->m_aCheckIssues = array_merge($this->m_aCheckIssues, $aNewIssues);
- }
- }
- // User rights
- //
- $aChanges = $this->ListChanges();
- if (count($aChanges) > 0)
- {
- $aForbiddenFields = array();
- foreach ($this->ListChanges() as $sAttCode => $value)
- {
- $bUpdateAllowed = UserRights::IsActionAllowedOnAttribute(get_class($this), $sAttCode, UR_ACTION_MODIFY, DBObjectSet::FromObject($this));
- if (!$bUpdateAllowed)
- {
- $oAttCode = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
- $aForbiddenFields[] = $oAttCode->GetLabel();
- }
- }
- if (count($aForbiddenFields) > 0)
- {
- // Security issue
- $this->m_bSecurityIssue = true;
- $this->m_aCheckIssues[] = Dict::Format('UI:Delete:NotAllowedToUpdate_Fields',implode(', ', $aForbiddenFields));
- }
- }
- }
- protected function DoCheckToDelete(&$oDeletionPlan)
- {
- parent::DoCheckToDelete($oDeletionPlan);
- // Plugins
- //
- foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
- {
- $aNewIssues = $oExtensionInstance->OnCheckToDelete($this);
- if (count($aNewIssues) > 0)
- {
- $this->m_aDeleteIssues = array_merge($this->m_aDeleteIssues, $aNewIssues);
- }
- }
- // User rights
- //
- $bDeleteAllowed = UserRights::IsActionAllowed(get_class($this), UR_ACTION_DELETE, DBObjectSet::FromObject($this));
- if (!$bDeleteAllowed)
- {
- // Security issue
- $this->m_bSecurityIssue = true;
- $this->m_aDeleteIssues[] = Dict::S('UI:Delete:NotAllowedToDelete');
- }
- }
- /**
- * Special display where the case log uses the whole "screen" at the bottom of the "Properties" tab
- */
- public function DisplayCaseLog(WebPage $oPage, $sAttCode, $sComment = '', $sPrefix = '', $bEditMode = false)
- {
- $oPage->SetCurrentTab(Dict::S('UI:PropertiesTab'));
- $sClass = get_class($this);
- if ($this->IsNew())
- {
- $iFlags = $this->GetInitialStateAttributeFlags($sAttCode);
- }
- else
- {
- $iFlags = $this->GetAttributeFlags($sAttCode);
- }
- if ( $iFlags & OPT_ATT_HIDDEN)
- {
- // The case log is hidden do nothing
- }
- else
- {
- $oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
- $sInputId = $this->m_iFormId.'_'.$sAttCode;
-
- if ((!$bEditMode) || ($iFlags & (OPT_ATT_READONLY|OPT_ATT_SLAVE)))
- {
- // Check if the attribute is not read-only because of a synchro...
- $aReasons = array();
- $sSynchroIcon = '';
- if ($iFlags & OPT_ATT_SLAVE)
- {
- $iSynchroFlags = $this->GetSynchroReplicaFlags($sAttCode, $aReasons);
- $sSynchroIcon = " <img id=\"synchro_$sInputId\" src=\"../images/transp-lock.png\" style=\"vertical-align:middle\"/>";
- $sTip = '';
- foreach($aReasons as $aRow)
- {
- $sTip .= "<p>Synchronized with {$aRow['name']} - {$aRow['description']}</p>";
- }
- $sTip = addslashes($sTip);
- $oPage->add_ready_script("$('#synchro_$sInputId').qtip( { content: '$sTip', show: 'mouseover', hide: 'mouseout', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );");
- }
- // Attribute is read-only
- $sHTMLValue = $this->GetAsHTML($sAttCode);
- $sHTMLValue .= '<input type="hidden" id="'.$sInputId.'" name="attr_'.$sPrefix.$sAttCode.'" value="'.htmlentities($this->GetEditValue($sAttCode), ENT_QUOTES, 'UTF-8').'"/>';
- $aFieldsMap[$sAttCode] = $sInputId;
- $sComment .= $sSynchroIcon;
- }
- else
- {
- $sValue = $this->Get($sAttCode);
- $sDisplayValue = $this->GetEditValue($sAttCode);
- $aArgs = array('this' => $this, 'formPrefix' => $sPrefix);
- $sHTMLValue = '';
- if ($sComment != '')
- {
- $sHTMLValue = '<span>'.$sComment.'</span><br/>';
- }
- $sHTMLValue .= "<span style=\"font-family:Tahoma,Verdana,Arial,Helvetica;font-size:12px;\" id=\"field_{$sInputId}\">".self::GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef, $sValue, $sDisplayValue, $sInputId, '', $iFlags, $aArgs).'</span>';
- $aFieldsMap[$sAttCode] = $sInputId;
- // Replace the text area with CKEditor
- // To change the default settings of the editor,
- // a) edit the file /js/ckeditor/config.js
- // b) or override some of the configuration settings, using the second parameter of ckeditor()
- $aConfig = array();
- $sLanguage = strtolower(trim(UserRights::GetUserLanguage()));
- $aConfig['font_style'] = $sLanguage;
- $aConfig['language'] = $sLanguage;
- $aConfig['contentsLanguage'] = $sLanguage;
- $aConfig['extraPlugins'] = 'disabler';
- $aConfig['placeholder'] = Dict::S('UI:CaseLogTypeYourTextHere');
- $sConfigJS = json_encode($aConfig);
-
- $oPage->add_ready_script("$('#$sInputId').ckeditor(function() { /* callback code */ }, $sConfigJS);"); // Transform $iId into a CKEdit
-
- }
- //$aVal = array('label' => '<span title="'.$oAttDef->GetDescription().'">'.$oAttDef->GetLabel().'</span>', 'value' => $sHTMLValue, 'comments' => $sComments, 'infos' => $sInfos);
- $oPage->add('<fieldset><legend>'.$oAttDef->GetLabel().'</legend>');
- $oPage->add($sHTMLValue);
- $oPage->add('</fieldset>');
- }
- }
-
- public function GetExpectedAttributes($sCurrentState, $sStimulus, $bOnlyNewOnes)
- {
- $aTransitions = $this->EnumTransitions();
- $aStimuli = MetaModel::EnumStimuli(get_class($this));
- if (!isset($aTransitions[$sStimulus]))
- {
- // Invalid stimulus
- throw new ApplicationException(Dict::Format('UI:Error:Invalid_Stimulus_On_Object_In_State', $sStimulus,$this->GetName(),$this->GetStateLabel()));
- }
- $aTransition = $aTransitions[$sStimulus];
- $sTargetState = $aTransition['target_state'];
- $aTargetStates = MetaModel::EnumStates(get_class($this));
- $aTargetState = $aTargetStates[$sTargetState];
- $aCurrentState = $aTargetStates[$this->GetState()];
- $aExpectedAttributes = $aTargetState['attribute_list'];
- $aCurrentAttributes = $aCurrentState['attribute_list'];
- $aComputedAttributes = array();
- foreach($aExpectedAttributes as $sAttCode => $iExpectCode)
- {
- if (!array_key_exists($sAttCode, $aCurrentAttributes))
- {
- $aComputedAttributes[$sAttCode] = $iExpectCode;
- }
- else
- {
- if ( !($aCurrentAttributes[$sAttCode] & (OPT_ATT_HIDDEN|OPT_ATT_READONLY)) )
- {
- $iExpectCode = $iExpectCode & ~(OPT_ATT_MUSTPROMPT|OPT_ATT_MUSTCHANGE); // Already prompted/changed, reset the flags
- }
- //TODO: better check if the attribute is not *null*
- if ( ($iExpectCode & OPT_ATT_MANDATORY) && ($this->Get($sAttCode) != ''))
- {
- $iExpectCode = $iExpectCode & ~(OPT_ATT_MANDATORY); // If the attribute is present, then no need to request its presence
- }
- $aComputedAttributes[$sAttCode] = $iExpectCode;
- }
- $aComputedAttributes[$sAttCode] = $aComputedAttributes[$sAttCode] & ~(OPT_ATT_READONLY|OPT_ATT_HIDDEN); // Don't care about this form now
- if ($aComputedAttributes[$sAttCode] == 0)
- {
- unset($aComputedAttributes[$sAttCode]);
- }
- }
- return $aComputedAttributes;
- }
- /**
- * Display a form for modifying several objects at once
- * The form will be submitted to the current page, with the specified additional values
- */
- public static function DisplayBulkModifyForm($oP, $sClass, $aSelectedObj, $sCustomOperation, $sCancelUrl, $aExcludeAttributes = array(), $aContextData = array())
- {
- if (count($aSelectedObj) > 0)
- {
- $iAllowedCount = count($aSelectedObj);
- $sSelectedObj = implode(',', $aSelectedObj);
- $sOQL = "SELECT $sClass WHERE id IN (".$sSelectedObj.")";
- $oSet = new CMDBObjectSet(DBObjectSearch::FromOQL($sOQL));
-
- // Compute the distribution of the values for each field to determine which of the "scalar" fields are homogenous
- $aList = MetaModel::ListAttributeDefs($sClass);
- $aValues = array();
- foreach($aList as $sAttCode => $oAttDef)
- {
- if ($oAttDef->IsScalar())
- {
- $aValues[$sAttCode] = array();
- }
- }
- while($oObj = $oSet->Fetch())
- {
- foreach($aList as $sAttCode => $oAttDef)
- {
- if ($oAttDef->IsScalar() && $oAttDef->IsWritable())
- {
- $currValue = $oObj->Get($sAttCode);
- if ($oAttDef instanceof AttributeCaseLog)
- {
- $currValue = ' '; // Don't put an empty string, in case the field would be considered as mandatory...
- }
- if (is_object($currValue)) continue; // Skip non scalar values...
- if(!array_key_exists($currValue, $aValues[$sAttCode]))
- {
- $aValues[$sAttCode][$currValue] = array('count' => 1, 'display' => $oObj->GetAsHTML($sAttCode));
- }
- else
- {
- $aValues[$sAttCode][$currValue]['count']++;
- }
- }
- }
- }
- // Now create an object that has values for the homogenous values only
- $oDummyObj = new $sClass(); // @@ What if the class is abstract ?
- $aComments = array();
- function MyComparison($a, $b) // Sort descending
- {
- if ($a['count'] == $b['count'])
- {
- return 0;
- }
- return ($a['count'] > $b['count']) ? -1 : 1;
- }
- $iFormId = cmdbAbstractObject::GetNextFormId(); // Identifier that prefixes all the form fields
- $sReadyScript = '';
- $aDependsOn = array();
- $sFormPrefix = '2_';
- foreach($aList as $sAttCode => $oAttDef)
- {
- $aPrerequisites = MetaModel::GetPrerequisiteAttributes($sClass, $sAttCode); // List of attributes that are needed for the current one
- if (count($aPrerequisites) > 0)
- {
- // When 'enabling' a field, all its prerequisites must be enabled too
- $sFieldList = "['{$sFormPrefix}".implode("','{$sFormPrefix}", $aPrerequisites)."']";
- $oP->add_ready_script("$('#enable_{$sFormPrefix}{$sAttCode}').bind('change', function(evt, sFormId) { return PropagateCheckBox( this.checked, $sFieldList, true); } );\n");
- }
- $aDependents = MetaModel::GetDependentAttributes($sClass, $sAttCode); // List of attributes that are needed for the current one
- if (count($aDependents) > 0)
- {
- // When 'disabling' a field, all its dependent fields must be disabled too
- $sFieldList = "['{$sFormPrefix}".implode("','{$sFormPrefix}", $aDependents)."']";
- $oP->add_ready_script("$('#enable_{$sFormPrefix}{$sAttCode}').bind('change', function(evt, sFormId) { return PropagateCheckBox( this.checked, $sFieldList, false); } );\n");
- }
- if ($oAttDef->IsScalar() && $oAttDef->IsWritable())
- {
- if ($oAttDef->GetEditClass() == 'One Way Password')
- {
-
- $sTip = "Unknown values";
- $sReadyScript .= "$('#multi_values_$sAttCode').qtip( { content: '$sTip', show: 'mouseover', hide: 'mouseout', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );";
- $oDummyObj->Set($sAttCode, null);
- $aComments[$sAttCode] = '<input type="checkbox" id="enable_'.$iFormId.'_'.$sAttCode.'" onClick="ToogleField(this.checked, \''.$iFormId.'_'.$sAttCode.'\')"/>';
- $aComments[$sAttCode] .= '<div class="multi_values" id="multi_values_'.$sAttCode.'"> ? </div>';
- $sReadyScript .= 'ToogleField(false, \''.$iFormId.'_'.$sAttCode.'\');'."\n";
- }
- else
- {
- $iCount = count($aValues[$sAttCode]);
- if ($iCount == 1)
- {
- // Homogenous value
- reset($aValues[$sAttCode]);
- $aKeys = array_keys($aValues[$sAttCode]);
- $currValue = $aKeys[0]; // The only value is the first key
- //echo "<p>current value for $sAttCode : $currValue</p>";
- $oDummyObj->Set($sAttCode, $currValue);
- $aComments[$sAttCode] = '';
- if ($sAttCode != MetaModel::GetStateAttributeCode($sClass))
- {
- $aComments[$sAttCode] .= '<input type="checkbox" checked id="enable_'.$iFormId.'_'.$sAttCode.'" onClick="ToogleField(this.checked, \''.$iFormId.'_'.$sAttCode.'\')"/>';
- }
- $aComments[$sAttCode] .= '<div class="mono_value">1</div>';
- }
- else
- {
- // Non-homogenous value
- $aMultiValues = $aValues[$sAttCode];
- uasort($aMultiValues, 'MyComparison');
- $iMaxCount = 5;
- $sTip = "<p><b>".Dict::Format('UI:BulkModify_Count_DistinctValues', $iCount)."</b><ul>";
- $index = 0;
- foreach($aMultiValues as $sCurrValue => $aVal)
- {
- $sDisplayValue = empty($aVal['display']) ? '<i>'.Dict::S('Enum:Undefined').'</i>' : str_replace(array("\n", "\r"), " ", $aVal['display']);
- $sTip .= "<li>".Dict::Format('UI:BulkModify:Value_Exists_N_Times', $sDisplayValue, $aVal['count'])."</li>";
- $index++;
- if ($iMaxCount == $index)
- {
- $sTip .= "<li>".Dict::Format('UI:BulkModify:N_MoreValues', count($aMultiValues) - $iMaxCount)."</li>";
- break;
- }
- }
- $sTip .= "</ul></p>";
- $sTip = addslashes($sTip);
- $sReadyScript .= "$('#multi_values_$sAttCode').qtip( { content: '$sTip', show: 'mouseover', hide: 'mouseout', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );";
-
- $oDummyObj->Set($sAttCode, null);
- $aComments[$sAttCode] = '';
- if ($sAttCode != MetaModel::GetStateAttributeCode($sClass))
- {
- $aComments[$sAttCode] .= '<input type="checkbox" id="enable_'.$iFormId.'_'.$sAttCode.'" onClick="ToogleField(this.checked, \''.$iFormId.'_'.$sAttCode.'\')"/>';
- }
- $aComments[$sAttCode] .= '<div class="multi_values" id="multi_values_'.$sAttCode.'">'.$iCount.'</div>';
- }
- $sReadyScript .= 'ToogleField('.(($iCount == 1) ? 'true': 'false').', \''.$iFormId.'_'.$sAttCode.'\');'."\n";
- }
- }
- }
-
- $sStateAttCode = MetaModel::GetStateAttributeCode($sClass);
- if (($sStateAttCode != '') && ($oDummyObj->GetState() == ''))
- {
- // Hmmm, it's not gonna work like this ! Set a default value for the "state"
- // Maybe we should use the "state" that is the most common among the objects...
- $aMultiValues = $aValues[$sStateAttCode];
- uasort($aMultiValues, 'MyComparison');
- foreach($aMultiValues as $sCurrValue => $aVal)
- {
- $oDummyObj->Set($sStateAttCode, $sCurrValue);
- break;
- }
- //$oStateAtt = MetaModel::GetAttributeDef($sClass, $sStateAttCode);
- //$oDummyObj->Set($sStateAttCode, $oStateAtt->GetDefaultValue());
- }
- $oP->add("<div class=\"page_header\">\n");
- $oP->add("<h1>".$oDummyObj->GetIcon()." ".Dict::Format('UI:Modify_M_ObjectsOf_Class_OutOf_N', $iAllowedCount, $sClass, $iAllowedCount)."</h1>\n");
- $oP->add("</div>\n");
- $oP->add("<div class=\"wizContainer\">\n");
- $sDisableFields = json_encode($aExcludeAttributes);
- $aParams = array
- (
- 'fieldsComments' => $aComments,
- 'noRelations' => true,
- 'custom_operation' => $sCustomOperation,
- 'custom_button' => Dict::S('UI:Button:PreviewModifications'),
- 'selectObj' => $sSelectedObj,
- 'preview_mode' => true,
- 'disabled_fields' => $sDisableFields,
- 'disable_plugins' => true
- );
- $aParams = $aParams + $aContextData; // merge keeping associations
-
- $oDummyObj->DisplayModifyForm($oP, $aParams);
- $oP->add("</div>\n");
- $oP->add_ready_script($sReadyScript);
- $oP->add_ready_script(
- <<<EOF
- $('.wizContainer button.cancel').unbind('click');
- $('.wizContainer button.cancel').click( function() { window.location.href = '$sCancelUrl'; } );
- EOF
- );
- } // Else no object selected ???
- else
- {
- $oP->p("No object selected !, nothing to do");
- }
- }
- /**
- * Process the reply made from a form built with DisplayBulkModifyForm
- */
- public static function DoBulkModify($oP, $sClass, $aSelectedObj, $sCustomOperation, $bPreview, $sCancelUrl, $aContextData = array())
- {
- $aHeaders = array(
- 'form::select' => array('label' => "<input type=\"checkbox\" onClick=\"CheckAll('.selectList:not(:disabled)', this.checked);\"></input>", 'description' => Dict::S('UI:SelectAllToggle+')),
- 'object' => array('label' => MetaModel::GetName($sClass), 'description' => Dict::S('UI:ModifiedObject')),
- 'status' => array('label' => Dict::S('UI:BulkModifyStatus'), 'description' => Dict::S('UI:BulkModifyStatus+')),
- 'errors' => array('label' => Dict::S('UI:BulkModifyErrors'), 'description' => Dict::S('UI:BulkModifyErrors+')),
- );
- $aRows = array();
- $oP->add("<div class=\"page_header\">\n");
- $oP->add("<h1>".MetaModel::GetClassIcon($sClass)." ".Dict::Format('UI:Modify_N_ObjectsOf_Class', count($aSelectedObj), MetaModel::GetName($sClass))."</h1>\n");
- $oP->add("</div>\n");
- $oP->set_title(Dict::Format('UI:Modify_N_ObjectsOf_Class', count($aSelectedObj), $sClass));
- if (!$bPreview)
- {
- // Not in preview mode, do the update for real
- $sTransactionId = utils::ReadPostedParam('transaction_id', '');
- if (!utils::IsTransactionValid($sTransactionId, false))
- {
- throw new Exception(Dict::S('UI:Error:ObjectAlreadyUpdated'));
- }
- utils::RemoveTransaction($sTransactionId);
- }
- $iPreviousTimeLimit = ini_get('max_execution_time');
- $iLoopTimeLimit = MetaModel::GetConfig()->Get('max_execution_time_per_loop');
- foreach($aSelectedObj as $iId)
- {
- set_time_limit($iLoopTimeLimit);
- $oObj = MetaModel::GetObject($sClass, $iId);
- $aErrors = $oObj->UpdateObjectFromPostedForm('');
- $bResult = (count($aErrors) == 0);
- if ($bResult)
- {
- list($bResult, $aErrors) = $oObj->CheckToWrite(true /* Enforce Read-only fields */);
- }
- if ($bPreview)
- {
- $sStatus = $bResult ? Dict::S('UI:BulkModifyStatusOk') : Dict::S('UI:BulkModifyStatusError');
- }
- else
- {
- $sStatus = $bResult ? Dict::S('UI:BulkModifyStatusModified') : Dict::S('UI:BulkModifyStatusSkipped');
- }
- $sCSSClass = $bResult ? HILIGHT_CLASS_NONE : HILIGHT_CLASS_CRITICAL;
- $sChecked = $bResult ? 'checked' : '';
- $sDisabled = $bResult ? '' : 'disabled';
- $aRows[] = array(
- 'form::select' => "<input type=\"checkbox\" class=\"selectList\" $sChecked $sDisabled\"></input>",
- 'object' => $oObj->GetHyperlink(),
- 'status' => $sStatus,
- 'errors' => '<p>'.($bResult ? '': implode('</p><p>', $aErrors)).'</p>',
- '@class' => $sCSSClass,
- );
- if ($bResult && (!$bPreview))
- {
- $oObj->DBUpdate();
- }
- }
- set_time_limit($iPreviousTimeLimit);
- $oP->Table($aHeaders, $aRows);
- if ($bPreview)
- {
- $sFormAction = utils::GetAbsoluteUrlAppRoot().'pages/UI.php'; // No parameter in the URL, the only parameter will be the ones passed through the form
- // Form to submit:
- $oP->add("<form method=\"post\" action=\"$sFormAction\" enctype=\"multipart/form-data\">\n");
- $aDefaults = utils::ReadParam('default', array());
- $oAppContext = new ApplicationContext();
- $oP->add($oAppContext->GetForForm());
- foreach ($aContextData as $sKey => $value)
- {
- $oP->add("<input type=\"hidden\" name=\"{$sKey}\" value=\"$value\">\n");
- }
- $oP->add("<input type=\"hidden\" name=\"operation\" value=\"$sCustomOperation\">\n");
- $oP->add("<input type=\"hidden\" name=\"class\" value=\"$sClass\">\n");
- $oP->add("<input type=\"hidden\" name=\"preview_mode\" value=\"0\">\n");
- $oP->add("<input type=\"hidden\" name=\"transaction_id\" value=\"".utils::GetNewTransactionId()."\">\n");
- $oP->add("<button type=\"button\" class=\"action cancel\" onClick=\"window.location.href='$sCancelUrl'\">".Dict::S('UI:Button:Cancel')."</button> \n");
- $oP->add("<button type=\"submit\" class=\"action\"><span>".Dict::S('UI:Button:ModifyAll')."</span></button>\n");
- foreach($_POST as $sKey => $value)
- {
- if (preg_match('/attr_(.+)/', $sKey, $aMatches))
- {
- // Beware: some values (like durations) are passed as arrays
- if (is_array($value))
- {
- foreach($value as $vKey => $vValue)
- {
- $oP->add("<input type=\"hidden\" name=\"{$sKey}[$vKey]\" value=\"".htmlentities($vValue, ENT_QUOTES, 'UTF-8')."\">\n");
- }
- }
- else
- {
- $oP->add("<input type=\"hidden\" name=\"$sKey\" value=\"".htmlentities($value, ENT_QUOTES, 'UTF-8')."\">\n");
- }
- }
- }
- $oP->add("</form>\n");
- }
- else
- {
- $oP->add("<button type=\"button\" onClick=\"window.location.href='$sCancelUrl'\" class=\"action\"><span>".Dict::S('UI:Button:Done')."</span></button>\n");
- }
- }
- /**
- * Perform all the needed checks to delete one (or more) objects
- */
- public static function DeleteObjects(WebPage $oP, $sClass, $aObjects, $bPreview, $sCustomOperation, $aContextData = array())
- {
- $oDeletionPlan = new DeletionPlan();
-
- foreach($aObjects as $oObj)
- {
- if ($bPreview)
- {
- $oObj->CheckToDelete($oDeletionPlan);
- }
- else
- {
- $oObj->DBDeleteTracked(CMDBObject::GetCurrentChange(), null, $oDeletionPlan);
- }
- }
-
- if ($bPreview)
- {
- if (count($aObjects) == 1)
- {
- $oObj = $aObjects[0];
- $oP->add("<h1>".Dict::Format('UI:Delete:ConfirmDeletionOf_Name', $oObj->GetName())."</h1>\n");
- }
- else
- {
- $oP->add("<h1>".Dict::Format('UI:Delete:ConfirmDeletionOf_Count_ObjectsOf_Class', count($aObjects), MetaModel::GetName($sClass))."</h1>\n");
- }
- // Explain what should be done
- //
- $aDisplayData = array();
- foreach ($oDeletionPlan->ListDeletes() as $sTargetClass => $aDeletes)
- {
- foreach ($aDeletes as $iId => $aData)
- {
- $oToDelete = $aData['to_delete'];
- $bAutoDel = (($aData['mode'] == DEL_SILENT) || ($aData['mode'] == DEL_AUTO));
- if (array_key_exists('issue', $aData))
- {
- if ($bAutoDel)
- {
- if (isset($aData['requested_explicitely']))
- {
- $sConsequence = Dict::Format('UI:Delete:CannotDeleteBecause', $aData['issue']);
- }
- else
- {
- $sConsequence = Dict::Format('UI:Delete:ShouldBeDeletedAtomaticallyButNotPossible', $aData['issue']);
- }
- }
- else
- {
- $sConsequence = Dict::Format('UI:Delete:MustBeDeletedManuallyButNotPossible', $aData['issue']);
- }
- }
- else
- {
- if ($bAutoDel)
- {
- if (isset($aData['requested_explicitely']))
- {
- $sConsequence = ''; // not applicable
- }
- else
- {
- $sConsequence = Dict::S('UI:Delete:WillBeDeletedAutomatically');
- }
- }
- else
- {
- $sConsequence = Dict::S('UI:Delete:MustBeDeletedManually');
- }
- }
- $aDisplayData[] = array(
- 'class' => MetaModel::GetName(get_class($oToDelete)),
- 'object' => $oToDelete->GetHyperLink(),
- 'consequence' => $sConsequence,
- );
- }
- }
- foreach ($oDeletionPlan->ListUpdates() as $sRemoteClass => $aToUpdate)
- {
- foreach ($aToUpdate as $iId => $aData)
- {
- $oToUpdate = $aData['to_reset'];
- if (array_key_exists('issue', $aData))
- {
- $sConsequence = Dict::Format('UI:Delete:CannotUpdateBecause_Issue', $aData['issue']);
- }
- else
- {
- $sConsequence = Dict::Format('UI:Delete:WillAutomaticallyUpdate_Fields', $aData['attributes_list']);
- }
- $aDisplayData[] = array(
- 'class' => MetaModel::GetName(get_class($oToUpdate)),
- 'object' => $oToUpdate->GetHyperLink(),
- 'consequence' => $sConsequence,
- );
- }
- }
-
- $iImpactedIndirectly = $oDeletionPlan->GetTargetCount() - count($aObjects);
- if ($iImpactedIndirectly > 0)
- {
- if (count($aObjects) == 1)
- {
- $oObj = $aObjects[0];
- $oP->p(Dict::Format('UI:Delete:Count_Objects/LinksReferencing_Object', $iImpactedIndirectly, $oObj->GetName()));
- }
- else
- {
- $oP->p(Dict::Format('UI:Delete:Count_Objects/LinksReferencingTheObjects', $iImpactedIndirectly));
- }
- $oP->p(Dict::S('UI:Delete:ReferencesMustBeDeletedToEnsureIntegrity'));
- }
-
- if (($iImpactedIndirectly > 0) || $oDeletionPlan->FoundStopper())
- {
- $aDisplayConfig = array();
- $aDisplayConfig['class'] = array('label' => 'Class', 'description' => '');
- $aDisplayConfig['object'] = array('label' => 'Object', 'description' => '');
- $aDisplayConfig['consequence'] = array('label' => 'Consequence', 'description' => Dict::S('UI:Delete:Consequence+'));
- $oP->table($aDisplayConfig, $aDisplayData);
- }
-
- if ($oDeletionPlan->FoundStopper())
- {
- if ($oDeletionPlan->FoundSecurityIssue())
- {
- $oP->p(Dict::S('UI:Delete:SorryDeletionNotAllowed'));
- }
- elseif ($oDeletionPlan->FoundManualOperation())
- {
- $oP->p(Dict::S('UI:Delete:PleaseDoTheManualOperations'));
- }
- else // $bFoundManualOp
- {
- $oP->p(Dict::S('UI:Delete:PleaseDoTheManualOperations'));
- }
- $oAppContext = new ApplicationContext();
- $oP->add("<form method=\"post\">\n");
- $oP->add("<input type=\"hidden\" name=\"transaction_id\" value=\"".utils::ReadParam('transaction_id')."\">\n");
- $oP->add("<input type=\"button\" onclick=\"window.history.back();\" value=\"".Dict::S('UI:Button:Back')."\">\n");
- $oP->add("<input DISABLED type=\"submit\" name=\"\" value=\"".Dict::S('UI:Button:Delete')."\">\n");
- $oP->add($oAppContext->GetForForm());
- $oP->add("</form>\n");
- }
- else
- {
- if (count($aObjects) == 1)
- {
- $oObj = $aObjects[0];
- $id = $oObj->GetKey();
- $oP->p('<h1>'.Dict::Format('UI:Delect:Confirm_Object', $oObj->GetHyperLink()).'</h1>');
- }
- else
- {
- $oP->p('<h1>'.Dict::Format('UI:Delect:Confirm_Count_ObjectsOf_Class', count($aObjects), MetaModel::GetName($sClass)).'</h1>');
- }
- foreach($aObjects as $oObj)
- {
- $aKeys[] = $oObj->GetKey();
- }
- $oFilter = new DBObjectSearch($sClass);
- $oFilter->AddCondition('id', $aKeys, 'IN');
- $oSet = new CMDBobjectSet($oFilter);
- $oP->add('<div id="0">');
- CMDBAbstractObject::DisplaySet($oP, $oSet, array('display_limit' => false, 'menu' => false));
- $oP->add("</div>\n");
- $oP->add("<form method=\"post\">\n");
- foreach ($aContextData as $sKey => $value)
- {
- $oP->add("<input type=\"hidden\" name=\"{$sKey}\" value=\"$value\">\n");
- }
- $oP->add("<input type=\"hidden\" name=\"transaction_id\" value=\"".utils::GetNewTransactionId()."\">\n");
- $oP->add("<input type=\"hidden\" name=\"operation\" value=\"$sCustomOperation\">\n");
- $oP->add("<input type=\"hidden\" name=\"filter\" value=\"".$oFilter->Serialize()."\">\n");
- $oP->add("<input type=\"hidden\" name=\"class\" value=\"$sClass\">\n");
- foreach($aObjects as $oObj)
- {
- $oP->add("<input type=\"hidden\" name=\"selectObject[]\" value=\"".$oObj->GetKey()."\">\n");
- }
- $oP->add("<input type=\"button\" onclick=\"window.history.back();\" value=\"".Dict::S('UI:Button:Back')."\">\n");
- $oP->add("<input type=\"submit\" name=\"\" value=\"".Dict::S('UI:Button:Delete')."\">\n");
- $oAppContext = new ApplicationContext();
- $oP->add($oAppContext->GetForForm());
- $oP->add("</form>\n");
- }
- }
- else // if ($bPreview)...
- {
- // Execute the deletion
- //
- if (count($aObjects) == 1)
- {
- $oObj = $aObjects[0];
- $oP->add("<h1>".Dict::Format('UI:Title:DeletionOf_Object', $oObj->GetName())."</h1>\n");
- }
- else
- {
- $oP->add("<h1>".Dict::Format('UI:Title:BulkDeletionOf_Count_ObjectsOf_Class', count($aObjects), MetaModel::GetName($sClass))."</h1>\n");
- }
- // Security - do not allow the user to force a forbidden delete by the mean of page arguments...
- if ($oDeletionPlan->FoundSecurityIssue())
- {
- throw new CoreException(Dict::S('UI:Error:NotEnoughRightsToDelete'));
- }
- if ($oDeletionPlan->FoundManualOperation())
- {
- throw new CoreException(Dict::S('UI:Error:CannotDeleteBecauseManualOpNeeded'));
- }
- if ($oDeletionPlan->FoundManualDelete())
- {
- throw new CoreException(Dict::S('UI:Error:CannotDeleteBecauseOfDepencies'));
- }
-
- // Report deletions
- //
- $aDisplayData = array();
- foreach ($oDeletionPlan->ListDeletes() as $sTargetClass => $aDeletes)
- {
- foreach ($aDeletes as $iId => $aData)
- {
- $oToDelete = $aData['to_delete'];
-
- if (isset($aData['requested_explicitely']))
- {
- $sMessage = Dict::S('UI:Delete:Deleted');
- }
- else
- {
- $sMessage = Dict::S('UI:Delete:AutomaticallyDeleted');
- }
- $aDisplayData[] = array(
- 'class' => MetaModel::GetName(get_class($oToDelete)),
- 'object' => $oToDelete->GetName(),
- 'consequence' => $sMessage,
- );
- }
- }
-
- // Report updates
- //
- foreach ($oDeletionPlan->ListUpdates() as $sTargetClass => $aToUpdate)
- {
- foreach ($aToUpdate as $iId => $aData)
- {
- $oToUpdate = $aData['to_reset'];
- $aDisplayData[] = array(
- 'class' => MetaModel::GetName(get_class($oToUpdate)),
- 'object' => $oToUpdate->GetHyperLink(),
- 'consequence' => Dict::Format('UI:Delete:AutomaticResetOf_Fields', $aData['attributes_list']),
- );
- }
- }
-
- // Report automatic jobs
- //
- if ($oDeletionPlan->GetTargetCount() > 0)
- {
- if (count($aObjects) == 1)
- {
- $oObj = $aObjects[0];
- $oP->p(Dict::Format('UI:Delete:CleaningUpRefencesTo_Object', $oObj->GetName()));
- }
- else
- {
- $oP->p(Dict::Format('UI:Delete:CleaningUpRefencesTo_Several_ObjectsOf_Class', count($aObjects), MetaModel::GetName($sClass)));
- }
- $aDisplayConfig = array();
- $aDisplayConfig['class'] = array('label' => 'Class', 'description' => '');
- $aDisplayConfig['object'] = array('label' => 'Object', 'description' => '');
- $aDisplayConfig['consequence'] = array('label' => 'Done', 'description' => Dict::S('UI:Delete:Done+'));
- $oP->table($aDisplayConfig, $aDisplayData);
- }
- }
- }
- /**
- * Find redundancy settings that can be viewed and modified in a tab
- * Settings are distributed to the corresponding link set attribute so as to be shown in the relevant tab
- */
- protected function FindVisibleRedundancySettings()
- {
- $aRet = array();
- foreach (MetaModel::ListAttributeDefs(get_class($this)) as $sAttCode => $oAttDef)
- {
- if ($oAttDef instanceof AttributeRedundancySettings)
- {
- if ($oAttDef->IsVisible())
- {
- $aQueryInfo = $oAttDef->GetRelationQueryData();
- if (isset($aQueryInfo['sAttribute']))
- {
- $oUpperAttDef = MetaModel::GetAttributeDef($aQueryInfo['sFromClass'], $aQueryInfo['sAttribute']);
- $oHostAttDef = $oUpperAttDef->GetMirrorLinkAttribute();
- if ($oHostAttDef)
- {
- $sHostAttCode = $oHostAttDef->GetCode();
- $aRet[$sHostAttCode][] = $oAttDef;
- }
- }
- }
- }
- }
- return $aRet;
- }
- /**
- * Generates the javascript code handle the "watchdog" associated with the concurrent access locking mechanism
- * @param Webpage $oPage
- * @param string $sOwnershipToken
- */
- protected function GetOwnershipJSHandler($oPage, $sOwnershipToken)
- {
- $iInterval = max(MIN_WATCHDOG_INTERVAL, MetaModel::GetConfig()->Get('concurrent_lock_expiration_delay')) * 1000 / 2; // Minimum interval for the watchdog is MIN_WATCHDOG_INTERVAL
- $sJSClass = json_encode(get_class($this));
- $iKey = (int) $this->GetKey();
- $sJSToken = json_encode($sOwnershipToken);
- $sJSTitle = json_encode(Dict::S('UI:DisconnectedDlgTitle'));
- $sJSOk = json_encode(Dict::S('UI:Button:Ok'));
- $oPage->add_ready_script(
- <<<EOF
- window.setInterval(function() {
- if (window.bInSubmit || window.bInCancel) return;
-
- $.post(GetAbsoluteUrlAppRoot()+'pages/ajax.render.php', {operation: 'extend_lock', obj_class: $sJSClass, obj_key: $iKey, token: $sJSToken }, function(data) {
- if (!data.status)
- {
- if ($('.lock_owned').length == 0)
- {
- $('.ui-layout-content').prepend('<div class="header_message message_error lock_owned">'+data.message+'</div>');
- $('<div>'+data.popup_message+'</div>').dialog({title: $sJSTitle, modal: true, autoOpen: true, buttons:[ {text: $sJSOk, click: function() { $(this).dialog('close'); } }], close: function() { $(this).remove(); }});
- }
- $('.wizContainer form button.action:not(.cancel)').attr('disabled', 'disabled');
- }
- else if ((data.operation == 'lost') || (data.operation == 'expired'))
- {
- if ($('.lock_owned').length == 0)
- {
- $('.ui-layout-content').prepend('<div class="header_message message_error lock_owned">'+data.message+'</div>');
- $('<div>'+data.popup_message+'</div>').dialog({title: $sJSTitle, modal: true, autoOpen: true, buttons:[ {text: $sJSOk, click: function() { $(this).dialog('close'); } }], close: function() { $(this).remove(); }});
- }
- $('.wizContainer form button.action:not(.cancel)').attr('disabled', 'disabled');
- }
- }, 'json');
- }, $iInterval);
- EOF
- );
- }
- }
|