From f2722e2c650940a4de272b1a6e4f98101dc5c1d2 Mon Sep 17 00:00:00 2001 From: DannyJoris Date: Tue, 18 Sep 2012 17:36:46 -0300 Subject: [PATCH] phase 2 of solution pack port - moved root collection into islandora - created a callback function for install and uninstall hooks --- css/islandora.admin.css | 6 ++ images/folder.png | Bin 0 -> 5137 bytes includes/islandora.ingest.inc | 4 +- includes/solution_packs.inc | 125 ++++++++++++++++++++++++---- islandora.install | 24 +++++- islandora.module | 41 ++++++++- xml/islandora_collection_policy.xml | 21 +++++ 7 files changed, 201 insertions(+), 20 deletions(-) create mode 100644 images/folder.png create mode 100644 xml/islandora_collection_policy.xml diff --git a/css/islandora.admin.css b/css/islandora.admin.css index 2e3a0f41..1cd1976d 100644 --- a/css/islandora.admin.css +++ b/css/islandora.admin.css @@ -8,4 +8,10 @@ .islandora-solution-pack-fieldset { padding-top: 0.5em; +} + +.islandora-solution-pack-fieldset table th, +.islandora-solution-pack-fieldset table td +{ + width: 33%; } \ No newline at end of file diff --git a/images/folder.png b/images/folder.png new file mode 100644 index 0000000000000000000000000000000000000000..f4c80d830c5360c15a503e50e0bf3d8f7df3cddf GIT binary patch literal 5137 zcmV+s6z=PZP))wk&$WN`P+PIpgrcYXi!egE%rzH?6r~`mkP4f4-3a;BW5y`Dee2L6FHHs1L>HT5-R${;5ad?Bl5JV}|r$ zbzXojnm%v_1!UagkPm+U(@&6-PliA(%y49`_bcbOC-hSf-Tx4*KBCtleGHO^^?3ml zU7%+LkDvYlw|V<_e)*pmO@=_tEVx3UuROH=P^NMPiNKG4YbFR3z}ugNTx9^PKQ0Ok z>0zx{wA`QiXjC^X5tzq#>8-G}GXY;k_DgQL+D zW19ll|4({*hpT_^Yk$Qt!|^(h&Ln<9=kA}L{X+Lcz@29~{}_KqMn*pFI6ag2-Pb?A z`i0(y!gX{=F43n$GXA*fH9*t(-3K20lfHeLF<^)SIt>OZe|H;pW*jU}kVXuNNcHzC)gB#Qw+p-EXuHvoTW4X{uM@Y)=ugB1W)%K!y~ zkl9C&Ar58b6%a0KD1@YXzQ|iTwH($AuR02!R6)-yfD~WZ^GwG813);oV3b~@gP?7! zkYc8WU{M;NU0H8W9cjyCR|E8x*ofc1mt!gHo${7!gCOH1%0+<6#1DZYwnzO6{tL!p# zEHR&ocNQB7Mo~2l;Y|QW_&EM!ykl!!*+y99$GE^X#|>)o1)71L%KB|AU>a&A)$D_@ zLWq5>d@PN};v7@IQ=C~0@jg}9K&w8e=XI;qf5yKSl9xxP z1TkJ(Vj|W&-sa;jQUagReAglS^z6vj08U~7vkU-SmGQYhCU}hbsn`PNy?9#SzfvU0 zrSN$*kz&SrgK4L!(plY}YH@-DLWE$L2r$y>Iiz}zLNMecj_!!98mQ9+piKi}AheHs zQ_L``#39oXfP!y~17|WOB$DNrfXrk9uAd(l70B546~Rx(AzNe5LY$iNscAsck_ohp zzL^*X#f`zGSY0_uKc;9C{*=5xJM%Zyew^jUUw4VJAVDHNW1JBz#RS|hlNJ;3U0vJ{ zj3d2RV5~f0^2z|l8Nt#tp!}-CK=q}8eQcyBF@MuZN=1S(SZh}pLSU8wfa?ZtGGNUS zp#E)I4ML^}kU~W-Oh6i;G|sGIJ>9b0T)_I|G9rK0BO_C}Dhb9g7UDKjBs_}qk1S2V zG+rkNo0klLSO79I3|H80#P+eg&o_-QL29N&;b$nv1pF+NNbzN{>2MT)a-0>HofJ4e z*6}RR|BD;p69J)C^!OP2(P3SdG0Opf$^;Zw*=eLGZNlTF$>N2xG>jr7L7X-pHxrB< zPZX?$a)7ag35DXBh_Z(UAg!UV8Cy0fyU3K6M-YLm4ZtM~AB zRk8QcAVFzpP%PRE)9a;~fY=({vk~TIqCpU?{SeiI+6@wg2#B;gghY)(ile>QwP9{ zFvCEoNp|jc8L#lN1ORjux+v%V5?f=#A3sQzR`!pFwz`F7q$Sxh!24{zGmSr-!vyjO z0PqZh$hhLgiIeO;v|Uqaop><=QU6~*dy5^u{52nm)HxXu+m8K@#ba?IGWh+7RNLV~7(Re700 z=_)gx=O!=x`xpO#V}^|E#MR;|LfEmFpv_rvl~pb|r^?upNON958s#j1UcjF^Gfq{g zt_KL$d4cVnFaP6zzQ{g@9NXrTY#V5XTbc=0v*yG5q8d?+pxm8D1!O&d)G~!u4y&v3S(=FKW`lM9H1&@M!V zW6qFQo#v+MJuWrmGVksD;a?2yu*(+r*kYS~29sBf>3K}Rb%U-aD7w=#zQb-*{Mai^ z=VtWQ2fq#f!&r2 zv3*LkSr#o{yMW>ndrl8Q4M91;Z*%kA%ddFiA6oGj2|yi`NK^xCPc@pH7wsvBsf%jK z0Etw3KsZC6i>$M4MRt2dN(lD3@k6%Q@j3$wKvrcXIfi7&5l0-8O*{5;n?OlMDp(RzdxH9Yoma@Bk-YEb zBvS8j&EW+$fyen3-r}~S0VO3TBZiD-6@N|+a0xB+1T?f_hZopsxJ5VSj}=G5qSqns z0B}FQ%|17*4%B8Krh2;UiILh3>K0GXGz`P{xfZeRu%6pi(G%bX-?PttiQ77^e_Jjo6Kzr=O+D?&6Fa<_)6maGBN zD2YvXKjKy1cNX0dnOP2JhkZ6U;3>XMhT<`?Fxwt3C*0J>NytY%zS zHD5_gmtPpI2egSFLb=5j8(gr9CE^)kyv4Hk{O{Q2$ucgd$ue<Q74y*f#d{W8V~Hnm}k-p|Bse=$V6|rjUu#@G_}*Wjx`-GRi5E zpu5|TnqvH!itHwVpgltL7wn&k7ch3+u1p;asR^l2sOGA%L_&EbwHktxjr&4#f$2ix z@linB*5fc4!tUVwbO3<5Ycm935(~6P0ilR0GB>0GpHTmwpNxt9Or=X z)*jCaeF*%bX?B_<7;c3(%ND6k1Mn-D&G1J&lQLeg<(AO1)8YW-?B?R{1sDe)mJh~5 zo{$-urciFv>Yhy*61{PHaX`2sUONry2|@6<@2S}!%m_;_P=4nt04d_P zw%s7xL*hCJrV$3mOZa}6WFqiLH5`f?e2d{5?|m?zS3EHXxWenHW5H%Aw2kh{rkvO@ zg5r>yJj3qs%%*+wd%*jw1Y>29YxNzE7P`8+cZ~1Ky40(quyv=a;)hD*EJDuUO z8~~&oyV#bP(-g>P$@JV^$0eu+hHcqGPR5Wse3jAg*2}N{M}D0H4jER<*=7JCok4gJ zZwpMk9YMzz$U+^6*8tnTUfXW4yt;0NFdV-A+?!WrlY4BjYdgfuShVK^psGC;036Z7 z+ibSlNKs9w3@M1lfNp#jx?bamZ5YZR8)nC&-E?pJjhESHn@zUa;ecVI9c>{1c;z^e zV$(~zk3eR}TlErULFm}kgvv>orzy3%vjXK@PmZw?jmXU)A7sOPl;uVc5hOJ^J8W~$ zYQO=*c_QL;D)FreY`%N$rxSEOJjzGLb|e)46sgvUQfZ=eCrNcjmu{~Z^~BSP*lr=^ zUbDs4-Ef!*!`zrbo|#crl|Mz3qeY6AfO}T_9rhVa-yS;;2N(?I_B;1+4mlbgD`(&G zf)`9KM%nFiYxPf3rCdwurhcnKx%4H+kV}>eg2{8^ExVGWekMYK5oH82uRD0?R7qv= z00=_%^yQ!V-2Td1M~aLjk9_^*wqhdC?&;l(=N;1@?k>jx3#G^oz;(Aw!P7`Sit4 z@~PEx8{2hItb%J`X~B+rEE_1qi0?2^`T~uhE$JFGh_Q20Mg%2-6z4QzNX96#zsiC% zz}1124&CqlV2!n(*f}>!jytGakCIdpJF?X6a4PZE5tNPf?y3U6rL(ymyRK|Up+p=v zss&N9)4jL*-dEY@hygjw9sh&sLhHZhJ8#)!yUvbeJ9WIt%FJ2hO4af0B49Bsk)jeL84N zmVNVI=#~S!e&PNN(HrY)8=_V>R@b4o-oH@R?9Pl*5zdYhF`OSI0&AmGO5bnXHG!h4 zhWx}%eJNZ@EQ}*Zld*Z`?qwSznZ`=XC2&BoFmJ#C8pt^2jJeW2$Qg3T3O&2&x3-tEDUH1R(YyP**Q$$6xP7xLmo7qg=e=B5$$Gi4lK1oCl_KCOBpW2Jt#6tuf5w23T_VB!lSFEUqY_e5 z`t<12rAJCq?W0k1UV^fhH`3n!G?o&C%L>k1d=NVQjR%FKfA*pw?XNsgwm|jrZVtjo z?RN&(uYPI!74C3{Z4T`6$T{c8)J(?}SDWe3AtfcP$USM$eDNr8{t`L^75p?;U6fl0 zow@Hp=&r0?1Tb>*zjxoX%VUe>k%N;=5vm!FRCbgTD`0){&Hobz5aq$68n89N31QLB zGU37mciCo>9S)uGpQ|LM<~TOIEQpRS9Pmfhh00-yhUU~}lte%&rT~sPWS3obIj~FQ zPB1~NPJFyy9djSKmkV*Pr_v5js4c}5bW$B_$Qf|V0f*Hhxs%L}&$UInn#p7o;gy)0 zS77pqQ8yr}f56y!*fGPZ1a_i1QuV*^-bv8-0O`g8G$FHhb8_()d1W)TpwEb3fJ!-$ zw5c|g;p8*q%f0yHvfy2a=pWrax_xx}=m!4-VW*uR;6Aq=00000NkvXXu0mjfNJ+K$ literal 0 HcmV?d00001 diff --git a/includes/islandora.ingest.inc b/includes/islandora.ingest.inc index 5308006d..a9869ed1 100644 --- a/includes/islandora.ingest.inc +++ b/includes/islandora.ingest.inc @@ -143,8 +143,8 @@ function islandora_ingest_new_object($object_model) { // build new object $object = islandora_ingest_new_object_prepare($namespace, $label, $datastreams, $content_models, $relationships); - // ingest new object - islandora_ingest_add_object($object); + // ingest (and return) new object + return islandora_ingest_add_object($object); } diff --git a/includes/solution_packs.inc b/includes/solution_packs.inc index f24c269d..5b7e24ef 100644 --- a/includes/solution_packs.inc +++ b/includes/solution_packs.inc @@ -36,6 +36,7 @@ function islandora_solution_packs_admin() { function islandora_solution_pack_form($form, &$form_state, $solution_pack_module, $solution_pack_name, $objects = array()) { // set variables + global $base_url; global $base_path; $needs_update = FALSE; $needs_install = FALSE; @@ -64,19 +65,23 @@ function islandora_solution_pack_form($form, &$form_state, $solution_pack_modul // table // header - $table_header = array('PID', 'Status'); + $table_header = array(t('Label'), t('PID'), t('Status')); $table_rows = array(); // loop over defined objects foreach ($objects as $object) { $datastreams = NULL; if (isset($object['pid'])) { + // set variables $pid = $object['pid']; // load object $item = islandora_object_load($pid); - $table_row = array($object['pid']); + // table row + $table_row = array(); + + // check out object status $object_status = t('Up-to-date'); if (!$item) { $object_status = t('Missing'); @@ -119,7 +124,19 @@ function islandora_solution_pack_form($form, &$form_state, $solution_pack_modul } } } - array_push($table_row, $object_status); + // label (prepend) + if ($needs_install) { + $label = $object['label'] ? $object['label'] : ''; + } + else { + $label = $object['label'] ? l($object['label'], $base_url . '/islandora/object/' . $pid) : ''; + } + $table_row[] = $label; + // pid + $table_row[] = $pid; + // object status + $table_row[] = $object_status; + // add row $table_rows[] = $table_row; } } @@ -212,24 +229,26 @@ function islandora_solution_pack_form_submit($form, &$form_state) { * @param type $context * @return type */ -function islandora_batch_reingest_object($object, &$context) { +function islandora_batch_reingest_object($object_model, &$context) { module_load_include('inc', 'islandora', 'includes/utilities'); module_load_include('inc', 'islandora', 'includes/islandora.ingest'); // include Tuque library module_load_include('inc', 'islandora', 'includes/tuque'); global $user; + global $base_url; // new connection try { $connection = new IslandoraTuque($user); - } catch (Exception $e) { + } + catch (Exception $e) { drupal_set_message(t('Unable to connect to the repository %e', array('%e' => $e)), 'error'); return; } - if (!empty($object) && is_array($object)) { + if (!empty($object_model) && is_array($object_model)) { // set and validate PID - $pid = $object['pid']; + $pid = $object_model['pid']; if (!islandora_validate_pid($pid)) { return NULL; } @@ -237,21 +256,95 @@ function islandora_batch_reingest_object($object, &$context) { // purge object // check if object already exits $object_query = $connection->api->a->findObjects('query', 'pid=' . $pid); + $reinstall = FALSE; if (!empty($object_query['results'])) { islandora_object_purge($pid); - } - else { - drupal_set_message(t('Content models for the basic image module already exist!'), 'warning'); + $reinstall = TRUE; } // build and ingest new object - islandora_ingest_new_object($object); + try { + $object = islandora_ingest_new_object($object_model); + $object_name = $object->label; + if ($reinstall) { + drupal_set_message(t('Successfully re-installed @object_name.', array('@object_name' => $object_name, '@pid' => $pid))); + } + else { + drupal_set_message(t('Successfully installed @object_name.', array('@object_name' => $object_name, '@pid' => $pid))); + } + } + catch (Exception $e) { + drupal_set_message(t('Installation of object @pid failed', array('@pid' => $pid)), 'error'); + } } } - - - - - +/** + * Callback function that can be called from the solution pack's hook_install() and hook_uninstall() functions. + * + * @TODO: add documentation + */ +function islandora_install_solution_pack($module_name = NULL, $op = 'install') { + if (!empty($module_name)) { + module_load_include('inc', 'islandora', 'includes/tuque'); + module_load_include('module', 'islandora', 'islandora'); + module_load_include('inc', 'islandora', 'includes/islandora.ingest'); + module_load_include('module', $module_name, $module_name); + global $base_url; + global $user; + + // get module info + $info_file = drupal_get_path('module', $module_name) . '/' . $module_name . '.info'; + $info_array = drupal_parse_info_file($info_file); + $module_label = $info_array['name']; + + // create new connection + try { + $connection = new IslandoraTuque($user); + } catch (Exception $e) { + drupal_set_message(st('Unable to connect to the repository %e', array('%e' => $e)), 'error'); + return; + } + + // get object models + $enabled_solution_packs = module_invoke_all('islandora_required_objects'); + $islandora_required_objects = $module_name . '_islandora_required_objects'; + $required_objects = $islandora_required_objects(); + $objects = $required_objects[$module_name]['objects']; + + // loop over object models + foreach ($objects as $object) { + // set variables + $pid = $object['pid']; + $label = isset($object['label']) ? $object['label'] : st('Object'); + // check if object already exists + $query = $connection->api->a->findObjects('query', 'pid=' . $pid); + + // operation: install or uninstall + switch ($op) { + case 'install': + // if object exists, don't re-ingest + if (!empty($query['results'])) { + $object_url = url($base_url . '/islandora/object/' . $pid); + drupal_set_message(st('@module_label: did not install @label because the object already exists.', array('@module_label' => $module_label, '@label' => $label, '@pid' => $pid, '!url' => $object_url)), 'warning'); + } + else { + // build and ingest new object + islandora_ingest_new_object($object); + // set message + drupal_set_message(st('@module_label: installed @label object.', array('@module_label' => $module_label, '@label' => $label, '@pid' => $pid))); + } + break; + + case 'uninstall': + // if object exists, set message + if (!empty($query['results'])) { + $object_url = url($base_url . '/islandora/object/' . $pid); + drupal_set_message(st('@module_label: Did not remove @label. It may be used by other sites.', array('@pid' => $pid, '!object_url' => $object_url, '@label' => $label, '@module_label' => $module_label)), 'warning'); + } + break; + } + } + } +} diff --git a/islandora.install b/islandora.install index 3fdd0fd7..1a4022b6 100644 --- a/islandora.install +++ b/islandora.install @@ -3,4 +3,26 @@ /** * @file * This file contains all install functions. - */ \ No newline at end of file + */ + +/** + * Implements hook_install(). + * + * @see islandora_islandora_required_objects(). + */ +function islandora_install() { + module_load_include('inc', 'islandora', 'includes/solution_packs'); + // install object(s) + islandora_install_solution_pack('islandora'); +} + +/** + * Implements hook_uninstall(). + * + * @see islandora_islandora_required_objects(). + */ +function islandora_uninstall() { + module_load_include('inc', 'islandora', 'includes/solution_packs'); + // uninstall callback + islandora_install_solution_pack('islandora', 'uninstall'); +} \ No newline at end of file diff --git a/islandora.module b/islandora.module index a506ae23..c745716a 100644 --- a/islandora.module +++ b/islandora.module @@ -565,4 +565,43 @@ function islandora_get_islandora_datastream_version($item = NULL, $dsid = NULL, } return $return; -} \ No newline at end of file +} + +/** + * Implements hook_islandora_required_objects(). + */ +function islandora_islandora_required_objects() { + + // module path + $module_path = drupal_get_path('module', 'islandora'); + + return array( + 'islandora' => array( + 'module' => 'islandora', + 'title' => 'Islandora', + 'objects' => array( + array( + 'pid' => 'islandora:root', + 'label' => 'Islandora top-level collection', + 'cmodel' => 'islandora:collectionCModel', + 'datastreams' => array( + array( + 'dsid' => 'COLLECTION_POLICY', + 'label' => 'Collection policy', + 'mimetype' => 'text/xml', + 'control_group' => 'X', + 'datastream_file' => "$module_path/xml/islandora_collection_policy.xml", + ), + array( + 'dsid' => 'TN', + 'label' => 'Thumbnail', + 'mimetype' => 'image/png', + 'control_group' => 'M', + 'datastream_file' => "$module_path/images/folder.png", + ), + ), + ), + ), + ), + ); +} diff --git a/xml/islandora_collection_policy.xml b/xml/islandora_collection_policy.xml new file mode 100644 index 00000000..9d74fb26 --- /dev/null +++ b/xml/islandora_collection_policy.xml @@ -0,0 +1,21 @@ + + + + + + dc.title + dc.creator + dc.description + dc.date + dc.identifier + dc.language + dc.publisher + dc.rights + dc.subject + dc.relation + dcterms.temporal + dcterms.spatial + Full text + + isMemberOfCollection + \ No newline at end of file