Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
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 | |
e7112fa7 | 31 | * @copyright CiviCRM LLC (c) 2004-2015 |
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) |
c8297314 | 48 | ->addStyleFile('civicrm', 'bower_components/google-code-prettify/bin/prettify.min.css', 99); |
89ee60d5 | 49 | |
e4176358 | 50 | $this->assign('operators', CRM_Core_DAO::acceptedSQLOperators()); |
89ee60d5 CW |
51 | |
52 | // List example directories | |
53 | global $civicrm_root; | |
54 | $examples = array(); | |
988e67ca | 55 | foreach (scandir(CRM_Utils_file::addTrailingSlash($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() { | |
79 | global $civicrm_root; | |
988e67ca | 80 | $basePath = CRM_Utils_file::addTrailingSlash($civicrm_root, '/'); |
89ee60d5 CW |
81 | if (!empty($_GET['entity']) && strpos($_GET['entity'], '.') === FALSE) { |
82 | $examples = array(); | |
988e67ca | 83 | foreach (scandir($basePath . 'api/v3/examples/' . $_GET['entity']) as $item) { |
89ee60d5 CW |
84 | $item = str_replace('.php', '', $item); |
85 | if ($item && strpos($item, '.') === FALSE) { | |
86 | $examples[] = array('key' => $item, 'value' => $item); | |
87 | } | |
88 | } | |
89 | CRM_Utils_JSON::output($examples); | |
90 | } | |
91 | if (!empty($_GET['file']) && strpos($_GET['file'], '.') === FALSE) { | |
988e67ca | 92 | $fileName = $basePath . 'api/v3/examples/' . $_GET['file'] . '.php'; |
89ee60d5 CW |
93 | if (file_exists($fileName)) { |
94 | echo file_get_contents($fileName); | |
95 | } | |
96 | else { | |
97 | echo "Not found."; | |
98 | } | |
99 | CRM_Utils_System::civiExit(); | |
100 | } | |
bc4aa590 CW |
101 | CRM_Utils_System::permissionDenied(); |
102 | } | |
103 | ||
104 | /** | |
ce064e4f | 105 | * Ajax callback to display code docs. |
bc4aa590 CW |
106 | */ |
107 | public static function getDoc() { | |
e80f05b2 CB |
108 | // Verify the API handler we're talking to is valid. |
109 | $entities = civicrm_api3('Entity', 'get'); | |
6469e038 CW |
110 | $entity = CRM_Utils_Array::value('entity', $_GET); |
111 | if (!empty($entity) && in_array($entity, $entities['values']) && strpos($entity, '.') === FALSE) { | |
bc4aa590 CW |
112 | $action = CRM_Utils_Array::value('action', $_GET); |
113 | $doc = self::getDocblock($entity, $action); | |
114 | $result = array( | |
115 | 'doc' => $doc ? self::formatDocBlock($doc[0]) : 'Not found.', | |
116 | 'code' => $doc ? $doc[1] : NULL, | |
cf3a4f07 | 117 | 'file' => $doc ? $doc[2] : NULL, |
bc4aa590 CW |
118 | ); |
119 | if (!$action) { | |
120 | $actions = civicrm_api3($entity, 'getactions'); | |
121 | $result['actions'] = CRM_Utils_Array::makeNonAssociative(array_combine($actions['values'], $actions['values'])); | |
122 | } | |
123 | CRM_Utils_JSON::output($result); | |
124 | } | |
125 | CRM_Utils_System::permissionDenied(); | |
126 | } | |
127 | ||
128 | /** | |
ce064e4f | 129 | * Get documentation block. |
130 | * | |
bc4aa590 CW |
131 | * @param string $entity |
132 | * @param string|null $action | |
133 | * @return array|bool | |
134 | * [docblock, code] | |
135 | */ | |
136 | private static function getDocBlock($entity, $action) { | |
137 | if (!$entity) { | |
138 | return FALSE; | |
139 | } | |
cf3a4f07 CW |
140 | $file = "api/v3/$entity.php"; |
141 | $contents = file_get_contents($file, FILE_USE_INCLUDE_PATH); | |
bc4aa590 CW |
142 | if (!$contents) { |
143 | // Api does not exist | |
144 | return FALSE; | |
145 | } | |
146 | $docblock = $code = array(); | |
147 | // Fetch docblock for the api file | |
148 | if (!$action) { | |
149 | if (preg_match('#/\*\*\n.*?\n \*/\n#s', $contents, $docblock)) { | |
cf3a4f07 | 150 | return array($docblock[0], NULL, $file); |
bc4aa590 CW |
151 | } |
152 | } | |
153 | // Fetch block for a specific action | |
154 | else { | |
155 | $action = strtolower($action); | |
156 | $fnName = 'civicrm_api3_' . _civicrm_api_get_entity_name_from_camel($entity) . '_' . $action; | |
157 | // Support the alternate "1 file per action" structure | |
cf3a4f07 CW |
158 | $actionFile = "api/v3/$entity/" . ucfirst($action) . '.php'; |
159 | $actionFileContents = file_get_contents("api/v3/$entity/" . ucfirst($action) . '.php', FILE_USE_INCLUDE_PATH); | |
160 | if ($actionFileContents) { | |
161 | $file = $actionFile; | |
162 | $contents = $actionFileContents; | |
bc4aa590 CW |
163 | } |
164 | // If action isn't in this file, try generic | |
41bd5fcb | 165 | if (strpos($contents, "function $fnName") === FALSE) { |
bc4aa590 | 166 | $fnName = "civicrm_api3_generic_$action"; |
cf3a4f07 CW |
167 | $file = "api/v3/Generic/" . ucfirst($action) . '.php'; |
168 | $contents = file_get_contents($file, FILE_USE_INCLUDE_PATH); | |
bc4aa590 | 169 | if (!$contents) { |
cf3a4f07 CW |
170 | $file = "api/v3/Generic.php"; |
171 | $contents = file_get_contents($file, FILE_USE_INCLUDE_PATH); | |
bc4aa590 CW |
172 | } |
173 | } | |
174 | if (preg_match('#(/\*\*(\n \*.*)*\n \*/\n)function[ ]+' . $fnName . '#i', $contents, $docblock)) { | |
175 | // Fetch the code in a separate regex to preserve sanity | |
176 | preg_match("#^function[ ]+$fnName.*?^}#ism", $contents, $code); | |
cf3a4f07 | 177 | return array($docblock[1], $code[0], $file); |
bc4aa590 CW |
178 | } |
179 | } | |
180 | } | |
181 | ||
182 | /** | |
183 | * Format a docblock to be a bit more readable | |
184 | * Not a proper doc parser... patches welcome :) | |
185 | * | |
186 | * @param string $text | |
187 | * @return string | |
188 | */ | |
189 | private static function formatDocBlock($text) { | |
190 | // Get rid of comment stars | |
191 | $text = str_replace(array("\n * ", "\n *\n", "\n */\n", "/**\n"), array("\n", "\n\n", '', ''), $text); | |
192 | ||
193 | // Format for html | |
194 | $text = htmlspecialchars($text); | |
195 | ||
196 | // Extract code blocks - save for later to skip html conversion | |
197 | $code = array(); | |
198 | preg_match_all('#@code(.*?)@endcode#is', $text, $code); | |
199 | $text = preg_replace('#@code.*?@endcode#is', '<pre></pre>', $text); | |
200 | ||
201 | // Convert @annotations to titles | |
202 | $text = preg_replace_callback( | |
203 | '#^[ ]*@(\w+)([ ]*)#m', | |
204 | function($matches) { | |
205 | return "<strong>" . ucfirst($matches[1]) . "</strong>" . (empty($matches[2]) ? '' : ': '); | |
206 | }, | |
207 | $text); | |
208 | ||
209 | // Preserve indentation | |
210 | $text = str_replace("\n ", "\n ", $text); | |
211 | ||
212 | // Convert newlines | |
213 | $text = nl2br($text); | |
214 | ||
215 | // Add unformatted code blocks back in | |
216 | if ($code && !empty($code[1])) { | |
217 | foreach ($code[1] as $block) { | |
fea52a54 | 218 | $text = preg_replace('#<pre></pre>#', "<pre>$block</pre>", $text, 1); |
bc4aa590 CW |
219 | } |
220 | } | |
221 | return $text; | |
89ee60d5 CW |
222 | } |
223 | ||
6a488035 | 224 | } |