3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright Tech To The People http:tttp.eu (c) 2008 |
7 +--------------------------------------------------------------------+
9 | CiviCRM is free software; you can copy, modify, and distribute it |
10 | under the terms of the GNU Affero General Public License |
11 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
13 | CiviCRM is distributed in the hope that it will be useful, but |
14 | WITHOUT ANY WARRANTY; without even the implied warranty of |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
16 | See the GNU Affero General Public License for more details. |
18 | You should have received a copy of the GNU Affero General Public |
19 | License and the CiviCRM Licensing Exception along |
20 | with this program; if not, contact CiviCRM LLC |
21 | at info[AT]civicrm[DOT]org. If you have questions about the |
22 | GNU Affero General Public License or the licensing of CiviCRM, |
23 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
24 +--------------------------------------------------------------------+
28 * This files provides several classes for doing command line work with
29 * CiviCRM. civicrm_cli is the base class. It's used by cli.php.
31 * In addition, there are several additional classes that inherit
32 * civicrm_cli to do more precise functions.
37 * base class for doing all command line operations via civicrm
41 // required values that must be passed
42 // via the command line
43 var $_required_arguments = array('action', 'entity');
44 var $_additional_arguments = array();
52 var $_site = 'localhost';
54 var $_password = NULL;
56 // all other arguments populate the parameters
57 // array that is passed to civicrm_api
58 var $_params = array('version' => 3);
60 var $_errors = array();
65 public function initialize() {
66 if (!$this->_accessing_from_cli()) {
69 if (!$this->_parseOptions()) {
72 if (!$this->_bootstrap()) {
75 if (!$this->_validateOptions()) {
82 * Ensure function is being run from the cli.
86 public function _accessing_from_cli() {
87 if (PHP_SAPI
=== 'cli') {
91 die("cli.php can only be run from command line.");
98 public function callApi() {
99 require_once 'api/api.php';
101 // CRM-9822 -'execute' action always goes thru Job api and always writes to log
102 if ($this->_action
!= 'execute' && $this->_joblog
) {
103 require_once 'CRM/Core/JobManager.php';
104 $facility = new CRM_Core_JobManager();
105 $facility->setSingleRunParams($this->_entity
, $this->_action
, $this->_params
, 'From Cli.php');
106 $facility->executeJobByAction($this->_entity
, $this->_action
);
109 // CRM-9822 cli.php calls don't require site-key, so bypass site-key authentication
110 $this->_params
['auth'] = FALSE;
111 $result = civicrm_api($this->_entity
, $this->_action
, $this->_params
);
114 if (!empty($result['is_error'])) {
115 $this->_log($result['error_message']);
118 elseif ($this->_output
=== 'json') {
119 echo json_encode($result, defined('JSON_PRETTY_PRINT') ? JSON_PRETTY_PRINT
: 0);
121 elseif ($this->_output
) {
122 print_r($result['values']);
130 private function _parseOptions() {
131 $args = $_SERVER['argv'];
132 // remove the first argument, which is the name
136 while (list($k, $arg) = each($args)) {
137 // sanitize all user input
138 $arg = $this->_sanitize($arg);
140 // if we're not parsing an option signifier
141 // continue to the next one
142 if (!preg_match('/^-/', $arg)) {
146 // find the value of this arg
147 if (preg_match('/=/', $arg)) {
148 $parts = explode('=', $arg);
153 if (isset($args[$k +
1])) {
154 $next_arg = $this->_sanitize($args[$k +
1]);
155 // if the next argument is not another option
156 // it's the value for this argument
157 if (!preg_match('/^-/', $next_arg)) {
163 // parse the special args first
164 if ($arg == '-e' ||
$arg == '--entity') {
165 $this->_entity
= $value;
167 elseif ($arg == '-a' ||
$arg == '--action') {
168 $this->_action
= $value;
170 elseif ($arg == '-s' ||
$arg == '--site') {
171 $this->_site
= $value;
173 elseif ($arg == '-u' ||
$arg == '--user') {
174 $this->_user
= $value;
176 elseif ($arg == '-p' ||
$arg == '--password') {
177 $this->_password
= $value;
179 elseif ($arg == '-o' ||
$arg == '--output') {
180 $this->_output
= TRUE;
182 elseif ($arg == '-J' ||
$arg == '--json') {
183 $this->_output
= 'json';
185 elseif ($arg == '-j' ||
$arg == '--joblog') {
186 $this->_joblog
= TRUE;
189 foreach ($this->_additional_arguments
as $short => $long) {
190 if ($arg == '-' . $short ||
$arg == '--' . $long) {
191 $property = '_' . $long;
192 $this->$property = $value;
196 // all other arguments are parameters
197 $key = ltrim($arg, '--');
198 $this->_params
[$key] = isset($value) ?
$value : NULL;
207 private function _bootstrap() {
208 // so the configuration works with php-cli
209 $_SERVER['PHP_SELF'] = "/index.php";
210 $_SERVER['HTTP_HOST'] = $this->_site
;
211 $_SERVER['REMOTE_ADDR'] = "127.0.0.1";
212 $_SERVER['SERVER_SOFTWARE'] = NULL;
213 $_SERVER['REQUEST_METHOD'] = 'GET';
215 // SCRIPT_FILENAME needed by CRM_Utils_System::cmsRootPath
216 $_SERVER['SCRIPT_FILENAME'] = __FILE__
;
218 // CRM-8917 - check if script name starts with /, if not - prepend it.
219 if (ord($_SERVER['SCRIPT_NAME']) != 47) {
220 $_SERVER['SCRIPT_NAME'] = '/' . $_SERVER['SCRIPT_NAME'];
223 $civicrm_root = dirname(__DIR__
);
224 chdir($civicrm_root);
225 if (getenv('CIVICRM_SETTINGS')) {
226 require_once getenv('CIVICRM_SETTINGS');
229 require_once 'civicrm.config.php';
232 if (!class_exists('CRM_Core_ClassLoader')) {
233 require_once $civicrm_root . '/CRM/Core/ClassLoader.php';
235 CRM_Core_ClassLoader
::singleton()->register();
237 $this->_config
= CRM_Core_Config
::singleton();
239 // HTTP_HOST will be 'localhost' unless overwritten with the -s argument.
240 // Now we have a Config object, we can set it from the Base URL.
241 if ($_SERVER['HTTP_HOST'] == 'localhost') {
242 $_SERVER['HTTP_HOST'] = preg_replace(
243 '!^https?://([^/]+)/$!i',
245 $this->_config
->userFrameworkBaseURL
);
248 $class = 'CRM_Utils_System_' . $this->_config
->userFramework
;
251 if (!CRM_Utils_System
::loadBootstrap(array(), FALSE, FALSE, $civicrm_root)) {
252 $this->_log(ts("Failed to bootstrap CMS"));
256 if (strtolower($this->_entity
) == 'job') {
258 $this->_log(ts("Jobs called from cli.php require valid user as parameter"));
263 if (!empty($this->_user
)) {
264 if (!CRM_Utils_System
::authenticateScript(TRUE, $this->_user
, $this->_password
, TRUE, FALSE, FALSE)) {
265 $this->_log(ts("Failed to login as %1. Wrong username or password.", array('1' => $this->_user
)));
268 if (!$cms->loadUser($this->_user
)) {
269 $this->_log(ts("Failed to login as %1", array('1' => $this->_user
)));
280 private function _validateOptions() {
281 $required = $this->_required_arguments
;
282 while (list(, $var) = each($required)) {
284 if (empty($this->$index)) {
285 $missing_arg = '--' . $var;
286 $this->_log(ts("The %1 argument is required", array(1 => $missing_arg)));
287 $this->_log($this->_getUsage());
299 private function _sanitize($value) {
300 // restrict user input - we should not be needing anything
301 // other than normal alpha numeric plus - and _.
302 return trim(preg_replace('#^[^a-zA-Z0-9\-_=/]$#', '', $value));
308 private function _getUsage() {
309 $out = "Usage: cli.php -e entity -a action [-u user] [-s site] [--output|--json] [PARAMS]\n";
310 $out .= " entity is the name of the entity, e.g. Contact, Event, etc.\n";
311 $out .= " action is the name of the action e.g. Get, Create, etc.\n";
312 $out .= " user is an optional username to run the script as\n";
313 $out .= " site is the domain name of the web site (for Drupal multi site installs)\n";
314 $out .= " --output will pretty print the result from the api call\n";
315 $out .= " --json will print the result from the api call as JSON\n";
316 $out .= " PARAMS is one or more --param=value combinations to pass to the api\n";
323 private function _log($error) {
324 // fixme, this should call some CRM_Core_Error:: function
325 // that properly logs
332 * class used by csv/export.php to export records from
333 * the database in a csv file format.
335 class civicrm_cli_csv_exporter
extends civicrm_cli
{
336 var $separator = ',';
340 public function __construct() {
341 $this->_required_arguments
= array('entity');
342 parent
::initialize();
345 public function run() {
346 $out = fopen("php://output", 'w');
347 fputcsv($out, $this->columns
, $this->separator
, '"');
350 $result = civicrm_api($this->_entity
, 'Get', $this->_params
);
352 foreach ($result['values'] as $row) {
354 $columns = array_keys($row);
355 fputcsv($out, $columns, $this->separator
, '"');
358 //handle values returned as arrays (i.e. custom fields that allow multiple selections) by inserting a control character
359 foreach ($row as &$field) {
360 if (is_array($field)) {
362 $field = implode($field, CRM_Core_DAO
::VALUE_SEPARATOR
) . CRM_Core_DAO
::VALUE_SEPARATOR
;
365 fputcsv($out, $row, $this->separator
, '"');
374 * base class used by both civicrm_cli_csv_import
375 * and civicrm_cli_csv_deleter to add or delete
376 * records based on those found in a csv file
377 * passed to the script.
379 class civicrm_cli_csv_file
extends civicrm_cli
{
381 var $separator = ',';
385 public function __construct() {
386 $this->_required_arguments
= array('entity', 'file');
387 $this->_additional_arguments
= array('f' => 'file');
388 parent
::initialize();
394 public function run() {
396 $handle = fopen($this->_file
, "r");
399 die("Could not open file: " . $this->_file
. ". Please provide an absolute path.\n");
403 $header = fgetcsv($handle, 0, $this->separator
);
404 // In case fgetcsv couldn't parse the header and dumped the whole line in 1 array element
405 // Try a different separator char
406 if (count($header) == 1) {
407 $this->separator
= ";";
409 $header = fgetcsv($handle, 0, $this->separator
);
410 if (count($header) == 1) {
411 die("Invalid file format for " . $this->_file
. ". It must be a valid csv with separator ',' or ';'\n");
415 $this->header
= $header;
416 while (($data = fgetcsv($handle, 0, $this->separator
)) !== FALSE) {
418 if (count($data) == 1 && is_null($data[0])) {
422 $params = $this->convertLine($data);
423 $this->processLine($params);
428 /* return a params as expected */
434 public function convertLine($data) {
436 foreach ($this->header
as $i => $field) {
437 //split any multiselect data, denoted with CRM_Core_DAO::VALUE_SEPARATOR
438 if (strpos($data[$i], CRM_Core_DAO
::VALUE_SEPARATOR
) !== FALSE) {
439 $data[$i] = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $data[$i]);
440 $data[$i] = array_combine($data[$i], $data[$i]);
442 $params[$field] = $data[$i];
444 $params['version'] = 3;
451 * class for processing records to add
452 * used by csv/import.php
455 class civicrm_cli_csv_importer
extends civicrm_cli_csv_file
{
457 * @param array $params
459 public function processline($params) {
460 $result = civicrm_api($this->_entity
, 'Create', $params);
461 if ($result['is_error']) {
462 echo "\nERROR line " . $this->row
. ": " . $result['error_message'] . "\n";
465 echo "\nline " . $this->row
. ": created " . $this->_entity
. " id: " . $result['id'] . "\n";
472 * class for processing records to delete
473 * used by csv/delete.php
476 class civicrm_cli_csv_deleter
extends civicrm_cli_csv_file
{
478 * @param array $params
480 public function processline($params) {
481 $result = civicrm_api($this->_entity
, 'Delete', $params);
482 if ($result['is_error']) {
483 echo "\nERROR line " . $this->row
. ": " . $result['error_message'] . "\n";
486 echo "\nline " . $this->row
. ": deleted\n";