1<?php 2/** 3 * DokuWiki Plugin struct (Helper Component) 4 * 5 * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html 6 * @author Andreas Gohr, Michael Große <dokuwiki@cosmocode.de> 7 */ 8 9// must be run within Dokuwiki 10use dokuwiki\plugin\struct\meta\AccessDataValidator; 11use dokuwiki\plugin\struct\meta\AccessTable; 12use dokuwiki\plugin\struct\meta\AccessTableLookup; 13use dokuwiki\plugin\struct\meta\Assignments; 14use dokuwiki\plugin\struct\meta\Schema; 15use dokuwiki\plugin\struct\meta\StructException; 16 17if(!defined('DOKU_INC')) die(); 18 19/** 20 * The public interface for the struct plugin 21 * 22 * 3rd party developers should always interact with struct data through this 23 * helper plugin only. If additionional interface functionality is needed, 24 * it should be added here. 25 * 26 * All functions will throw StructExceptions when something goes wrong. 27 * 28 * Remember to check permissions yourself! 29 */ 30class helper_plugin_struct extends DokuWiki_Plugin { 31 32 /** 33 * Get the structured data of a given page 34 * 35 * @param string $page The page to get data for 36 * @param string|null $schema The schema to use null for all 37 * @param int $time A timestamp if you want historic data (0 for now) 38 * @return array ('schema' => ( 'fieldlabel' => 'value', ...)) 39 * @throws StructException 40 */ 41 public function getData($page, $schema = null, $time = 0) { 42 $page = cleanID($page); 43 44 if(is_null($schema)) { 45 $assignments = Assignments::getInstance(); 46 $schemas = $assignments->getPageAssignments($page, false); 47 } else { 48 $schemas = array($schema); 49 } 50 51 $result = array(); 52 foreach($schemas as $schema) { 53 $schemaData = AccessTable::byTableName($schema, $page, $time); 54 $result[$schema] = $schemaData->getDataArray(); 55 } 56 57 return $result; 58 } 59 60 /** 61 * Saves data for a given page (creates a new revision) 62 * 63 * If this call succeeds you can assume your data has either been saved or it was 64 * not necessary to save it because the data already existed in the wanted form or 65 * the given schemas are no longer assigned to that page. 66 * 67 * Important: You have to check write permissions for the given page before calling 68 * this function yourself! 69 * 70 * this duplicates a bit of code from entry.php - we could also fake post data and let 71 * entry handle it, but that would be rather unclean and might be problematic when multiple 72 * calls are done within the same request. 73 * 74 * @todo should this try to lock the page? 75 * 76 * 77 * @param string $page 78 * @param array $data ('schema' => ( 'fieldlabel' => 'value', ...)) 79 * @param string $summary 80 * @throws StructException 81 */ 82 public function saveData($page, $data, $summary = '') { 83 $page = cleanID($page); 84 $summary = trim($summary); 85 if(!$summary) $summary = $this->getLang('summary'); 86 87 if(!page_exists($page)) throw new StructException("Page does not exist. You can not attach struct data"); 88 89 // validate and see if anything changes 90 $valid = AccessDataValidator::validateDataForPage($data, $page, $errors); 91 if($valid === false) { 92 throw new StructException("Validation failed:\n%s", join("\n", $errors)); 93 } 94 if(!$valid) return; // empty array when no changes were detected 95 96 $newrevision = self::createPageRevision($page, $summary); 97 98 // save the provided data 99 $assignments = Assignments::getInstance(); 100 foreach($valid as $v) { 101 $v->saveData($newrevision); 102 // make sure this schema is assigned 103 $assignments->assignPageSchema($page, $v->getAccessTable()->getSchema()->getTable()); 104 } 105 } 106 107 /** 108 * Save data row for a lookup schema 109 * 110 * @param AccessTableLookup $access the table into which to save the data 111 * @param array $data data to be saved in the form of [columnName => 'data'] 112 */ 113 public function saveLookupData(AccessTableLookup $access, $data) 114 { 115 if(!$access->getSchema()->isEditable()) { 116 throw new StructException('lookup save error: no permission for schema'); 117 } 118 $validator = $access->getValidator($data); 119 if(!$validator->validate()) { 120 throw new StructException("Validation failed:\n%s", implode("\n", $validator->getErrors())); 121 } 122 if(!$validator->saveData()) { 123 throw new StructException('No data saved'); 124 } 125 } 126 127 /** 128 * Creates a new page revision with the same page content as before 129 * 130 * @param string $page 131 * @param string $summary 132 * @param bool $minor 133 * @return int the new revision 134 */ 135 static public function createPageRevision($page, $summary = '', $minor = false) { 136 $summary = trim($summary); 137 // force a new page revision @see action_plugin_struct_entry::handle_pagesave_before() 138 $GLOBALS['struct_plugin_force_page_save'] = true; 139 saveWikiText($page, rawWiki($page), $summary, $minor); 140 unset($GLOBALS['struct_plugin_force_page_save']); 141 $file = wikiFN($page); 142 clearstatcache(false, $file); 143 return filemtime($file); 144 } 145 146 /** 147 * Get info about existing schemas 148 * 149 * @param string|null $schema the schema to query, null for all 150 * @return Schema[] 151 * @throws StructException 152 */ 153 public function getSchema($schema = null) { 154 if(is_null($schema)) { 155 $schemas = Schema::getAll(); 156 } else { 157 $schemas = array($schema); 158 } 159 160 $result = array(); 161 foreach($schemas as $table) { 162 $result[$table] = new Schema($table); 163 } 164 return $result; 165 } 166 167 /** 168 * Returns all pages known to the struct plugin 169 * 170 * That means all pages that have or had once struct data saved 171 * 172 * @param string|null $schema limit the result to a given schema 173 * @return array (page => (schema => true), ...) 174 * @throws StructException 175 */ 176 public function getPages($schema = null) { 177 $assignments = Assignments::getInstance(); 178 return $assignments->getPages($schema); 179 } 180 181} 182