Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
0f03f337 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
0f03f337 | 31 | * @copyright CiviCRM LLC (c) 2004-2017 |
6a488035 TO |
32 | */ |
33 | ||
34 | /** | |
0c3a6e64 | 35 | * Api Explorer |
6a488035 TO |
36 | */ |
37 | class CRM_Admin_Page_APIExplorer extends CRM_Core_Page { | |
38 | ||
e0ef6999 | 39 | /** |
ce064e4f | 40 | * Run page. |
41 | * | |
e0ef6999 EM |
42 | * @return string |
43 | */ | |
00be9182 | 44 | public function run() { |
2b6e1174 CW |
45 | CRM_Core_Resources::singleton() |
46 | ->addScriptFile('civicrm', 'templates/CRM/Admin/Page/APIExplorer.js') | |
37d79aed | 47 | ->addScriptFile('civicrm', 'bower_components/google-code-prettify/bin/prettify.min.js', 99) |
5b46e216 | 48 | ->addStyleFile('civicrm', 'bower_components/google-code-prettify/bin/prettify.min.css', 99) |
8bcc0d86 | 49 | ->addVars('explorer', array('max_joins' => \Civi\API\Api3SelectQuery::MAX_JOINS)); |
89ee60d5 | 50 | |
e4176358 | 51 | $this->assign('operators', CRM_Core_DAO::acceptedSQLOperators()); |
89ee60d5 CW |
52 | |
53 | // List example directories | |
89ee60d5 | 54 | $examples = array(); |
29848076 | 55 | foreach (scandir(\Civi::paths()->getPath('[civicrm.root]/api/v3/examples')) as $item) { |
89ee60d5 CW |
56 | if ($item && strpos($item, '.') === FALSE) { |
57 | $examples[] = $item; | |
58 | } | |
59 | } | |
60 | $this->assign('examples', $examples); | |
61 | ||
6a488035 TO |
62 | return parent::run(); |
63 | } | |
64 | ||
6a488035 TO |
65 | /** |
66 | * Get user context. | |
67 | * | |
a6c01b45 CW |
68 | * @return string |
69 | * user context. | |
6a488035 | 70 | */ |
00be9182 | 71 | public function userContext() { |
d5a9020d | 72 | return 'civicrm/api'; |
6a488035 | 73 | } |
96025800 | 74 | |
89ee60d5 | 75 | /** |
ce064e4f | 76 | * AJAX callback to fetch examples. |
89ee60d5 CW |
77 | */ |
78 | public static function getExampleFile() { | |
89ee60d5 CW |
79 | if (!empty($_GET['entity']) && strpos($_GET['entity'], '.') === FALSE) { |
80 | $examples = array(); | |
29848076 | 81 | foreach (scandir(\Civi::paths()->getPath("[civicrm.root]/api/v3/examples/{$_GET['entity']}")) as $item) { |
89ee60d5 CW |
82 | $item = str_replace('.php', '', $item); |
83 | if ($item && strpos($item, '.') === FALSE) { | |
84 | $examples[] = array('key' => $item, 'value' => $item); | |
85 | } | |
86 | } | |
87 | CRM_Utils_JSON::output($examples); | |
88 | } | |
89 | if (!empty($_GET['file']) && strpos($_GET['file'], '.') === FALSE) { | |
29848076 | 90 | $fileName = \Civi::paths()->getPath("[civicrm.root]/api/v3/examples/{$_GET['file']}.php"); |
89ee60d5 CW |
91 | if (file_exists($fileName)) { |
92 | echo file_get_contents($fileName); | |
93 | } | |
94 | else { | |
95 | echo "Not found."; | |
96 | } | |
97 | CRM_Utils_System::civiExit(); | |
98 | } | |
bc4aa590 CW |
99 | CRM_Utils_System::permissionDenied(); |
100 | } | |
101 | ||
102 | /** | |
ce064e4f | 103 | * Ajax callback to display code docs. |
bc4aa590 CW |
104 | */ |
105 | public static function getDoc() { | |
e80f05b2 CB |
106 | // Verify the API handler we're talking to is valid. |
107 | $entities = civicrm_api3('Entity', 'get'); | |
6469e038 CW |
108 | $entity = CRM_Utils_Array::value('entity', $_GET); |
109 | if (!empty($entity) && in_array($entity, $entities['values']) && strpos($entity, '.') === FALSE) { | |
bc4aa590 CW |
110 | $action = CRM_Utils_Array::value('action', $_GET); |
111 | $doc = self::getDocblock($entity, $action); | |
112 | $result = array( | |
113 | 'doc' => $doc ? self::formatDocBlock($doc[0]) : 'Not found.', | |
114 | 'code' => $doc ? $doc[1] : NULL, | |
cf3a4f07 | 115 | 'file' => $doc ? $doc[2] : NULL, |
bc4aa590 CW |
116 | ); |
117 | if (!$action) { | |
118 | $actions = civicrm_api3($entity, 'getactions'); | |
119 | $result['actions'] = CRM_Utils_Array::makeNonAssociative(array_combine($actions['values'], $actions['values'])); | |
120 | } | |
121 | CRM_Utils_JSON::output($result); | |
122 | } | |
123 | CRM_Utils_System::permissionDenied(); | |
124 | } | |
125 | ||
126 | /** | |
ce064e4f | 127 | * Get documentation block. |
128 | * | |
bc4aa590 CW |
129 | * @param string $entity |
130 | * @param string|null $action | |
131 | * @return array|bool | |
132 | * [docblock, code] | |
133 | */ | |
134 | private static function getDocBlock($entity, $action) { | |
135 | if (!$entity) { | |
136 | return FALSE; | |
137 | } | |
cf3a4f07 CW |
138 | $file = "api/v3/$entity.php"; |
139 | $contents = file_get_contents($file, FILE_USE_INCLUDE_PATH); | |
bc4aa590 CW |
140 | if (!$contents) { |
141 | // Api does not exist | |
142 | return FALSE; | |
143 | } | |
144 | $docblock = $code = array(); | |
145 | // Fetch docblock for the api file | |
146 | if (!$action) { | |
147 | if (preg_match('#/\*\*\n.*?\n \*/\n#s', $contents, $docblock)) { | |
cf3a4f07 | 148 | return array($docblock[0], NULL, $file); |
bc4aa590 CW |
149 | } |
150 | } | |
151 | // Fetch block for a specific action | |
152 | else { | |
153 | $action = strtolower($action); | |
154 | $fnName = 'civicrm_api3_' . _civicrm_api_get_entity_name_from_camel($entity) . '_' . $action; | |
155 | // Support the alternate "1 file per action" structure | |
cf3a4f07 CW |
156 | $actionFile = "api/v3/$entity/" . ucfirst($action) . '.php'; |
157 | $actionFileContents = file_get_contents("api/v3/$entity/" . ucfirst($action) . '.php', FILE_USE_INCLUDE_PATH); | |
158 | if ($actionFileContents) { | |
159 | $file = $actionFile; | |
160 | $contents = $actionFileContents; | |
bc4aa590 CW |
161 | } |
162 | // If action isn't in this file, try generic | |
41bd5fcb | 163 | if (strpos($contents, "function $fnName") === FALSE) { |
bc4aa590 | 164 | $fnName = "civicrm_api3_generic_$action"; |
cf3a4f07 CW |
165 | $file = "api/v3/Generic/" . ucfirst($action) . '.php'; |
166 | $contents = file_get_contents($file, FILE_USE_INCLUDE_PATH); | |
bc4aa590 | 167 | if (!$contents) { |
cf3a4f07 CW |
168 | $file = "api/v3/Generic.php"; |
169 | $contents = file_get_contents($file, FILE_USE_INCLUDE_PATH); | |
bc4aa590 CW |
170 | } |
171 | } | |
172 | if (preg_match('#(/\*\*(\n \*.*)*\n \*/\n)function[ ]+' . $fnName . '#i', $contents, $docblock)) { | |
173 | // Fetch the code in a separate regex to preserve sanity | |
174 | preg_match("#^function[ ]+$fnName.*?^}#ism", $contents, $code); | |
cf3a4f07 | 175 | return array($docblock[1], $code[0], $file); |
bc4aa590 CW |
176 | } |
177 | } | |
178 | } | |
179 | ||
180 | /** | |
181 | * Format a docblock to be a bit more readable | |
182 | * Not a proper doc parser... patches welcome :) | |
183 | * | |
184 | * @param string $text | |
185 | * @return string | |
186 | */ | |
eecd39e1 TO |
187 | public static function formatDocBlock($text) { |
188 | // Normalize #leading spaces. | |
189 | $lines = explode("\n", $text); | |
190 | $lines = preg_replace('/^ +\*/', ' *', $lines); | |
191 | $text = implode("\n", $lines); | |
192 | ||
bc4aa590 CW |
193 | // Get rid of comment stars |
194 | $text = str_replace(array("\n * ", "\n *\n", "\n */\n", "/**\n"), array("\n", "\n\n", '', ''), $text); | |
195 | ||
196 | // Format for html | |
197 | $text = htmlspecialchars($text); | |
198 | ||
199 | // Extract code blocks - save for later to skip html conversion | |
200 | $code = array(); | |
201 | preg_match_all('#@code(.*?)@endcode#is', $text, $code); | |
202 | $text = preg_replace('#@code.*?@endcode#is', '<pre></pre>', $text); | |
203 | ||
204 | // Convert @annotations to titles | |
205 | $text = preg_replace_callback( | |
206 | '#^[ ]*@(\w+)([ ]*)#m', | |
207 | function($matches) { | |
208 | return "<strong>" . ucfirst($matches[1]) . "</strong>" . (empty($matches[2]) ? '' : ': '); | |
209 | }, | |
210 | $text); | |
211 | ||
212 | // Preserve indentation | |
213 | $text = str_replace("\n ", "\n ", $text); | |
214 | ||
215 | // Convert newlines | |
216 | $text = nl2br($text); | |
217 | ||
218 | // Add unformatted code blocks back in | |
219 | if ($code && !empty($code[1])) { | |
220 | foreach ($code[1] as $block) { | |
fea52a54 | 221 | $text = preg_replace('#<pre></pre>#', "<pre>$block</pre>", $text, 1); |
bc4aa590 CW |
222 | } |
223 | } | |
224 | return $text; | |
89ee60d5 CW |
225 | } |
226 | ||
6a488035 | 227 | } |