easyappointments/application/controllers/Console.php

258 lines
7.3 KiB
PHP
Raw Normal View History

<?php defined('BASEPATH') or exit('No direct script access allowed');
/* ----------------------------------------------------------------------------
* Easy!Appointments - Open Source Web Scheduler
*
* @package EasyAppointments
* @author A.Tselegidis <alextselegidis@gmail.com>
* @copyright Copyright (c) 2013 - 2020, Alex Tselegidis
2020-11-14 22:36:25 +03:00
* @license https://opensource.org/licenses/GPL-3.0 - GPLv3
* @link https://easyappointments.org
* @since v1.3.2
* ---------------------------------------------------------------------------- */
2020-12-04 13:49:57 +03:00
require_once __DIR__ . '/Google.php';
/**
* Class Console
*
* CLI commands of Easy!Appointments, can only be executed from a terminal and not with a direct request.
*/
class Console extends EA_Controller {
/**
* Console constructor.
*/
public function __construct()
{
if ( ! is_cli())
{
exit('No direct script access allowed');
}
parent::__construct();
$this->load->dbutil();
$this->load->helper('file');
$this->load->library('migration');
2020-12-04 13:49:57 +03:00
$this->load->model('admins_model');
$this->load->model('customers_model');
$this->load->model('providers_model');
2020-12-04 13:49:57 +03:00
$this->load->model('services_model');
$this->load->model('settings_model');
}
2020-12-09 15:17:45 +03:00
/**
* Perform a console installation.
*
* Use this method to install Easy!Appointments directly from the terminal.
*
* Usage:
*
* php index.php console install
*/
public function install()
{
$this->migrate('fresh');
$this->seed();
$this->output->set_output(PHP_EOL . '⇾ Installation completed, login with "administrator" / "administrator".' . PHP_EOL . PHP_EOL);
}
/**
* Migrate the database to the latest state.
*
* Use this method to upgrade an existing installation to the latest database state.
*
* Notice:
*
* Do not use this method to install the app as it will not seed the database with the initial entries (admin,
* provider, service, settings etc). Use the UI installation page for this.
*
* Usage:
*
* php index.php console migrate
2020-12-02 23:21:35 +03:00
*
2020-12-04 13:49:57 +03:00
* php index.php console migrate fresh
*
2020-12-02 23:21:35 +03:00
* @param string $type
*/
2020-12-02 23:21:35 +03:00
public function migrate($type = '')
{
2020-12-02 23:21:35 +03:00
if ($type === 'fresh' && $this->migration->version(0) === FALSE)
{
show_error($this->migration->error_string());
}
if ($this->migration->latest() === FALSE)
{
show_error($this->migration->error_string());
}
}
2020-12-04 13:49:57 +03:00
/**
* Seed the database with test data.
*
* Use this method to add test data to your database
*
* Usage:
*
* php index.php console seed
*/
public function seed()
{
// Settings
$this->settings_model->set_setting('company_name', 'Company Name');
$this->settings_model->set_setting('company_email', 'info@example.org');
$this->settings_model->set_setting('company_link', 'https://example.org');
// Admin
$this->admins_model->add([
'first_name' => 'John',
'last_name' => 'Doe',
'email' => 'john@example.org',
'phone_number' => '+1 (000) 000-0000',
'settings' => [
'username' => 'administrator',
'password' => 'administrator',
'notifications' => TRUE,
2020-12-04 13:49:57 +03:00
'calendar_view' => CALENDAR_VIEW_DEFAULT
],
]);
// Service
$service_id = $this->services_model->add([
'name' => 'Service',
'duration' => '30',
'price' => '0',
'currency' => '',
'availabilities_type' => 'flexible',
'attendants_number' => '1'
]);
// Provider
$this->providers_model->add([
'first_name' => 'Jane',
'last_name' => 'Doe',
'email' => 'jane@example.org',
'phone_number' => '+1 (000) 000-0000',
'services' => [
$service_id
],
'settings' => [
'username' => 'janedoe',
'password' => 'janedoe',
'working_plan' => $this->settings_model->get_setting('company_working_plan'),
'notifications' => TRUE,
2020-12-04 13:49:57 +03:00
'google_sync' => FALSE,
'sync_past_days' => 30,
'sync_future_days' => 90,
2020-12-04 13:49:57 +03:00
'calendar_view' => CALENDAR_VIEW_DEFAULT
],
]);
// Customer
$this->customers_model->add([
'first_name' => 'James',
'last_name' => 'Doe',
'email' => 'james@example.org',
'phone_number' => '+1 (000) 000-0000',
]);
}
/**
* Create a backup file.
*
* Use this method to backup your Easy!Appointments data.
*
* Usage:
*
* php index.php console backup
*
* php index.php console backup /path/to/backup/folder
*
* @throws Exception
*/
public function backup()
{
$path = isset($GLOBALS['argv'][3]) ? $GLOBALS['argv'][3] : APPPATH . '/../storage/backups';
if ( ! file_exists($path))
{
throw new Exception('The backup path does not exist™: ' . $path);
}
if ( ! is_writable($path))
{
throw new Exception('The backup path is not writable: ' . $path);
}
$contents = $this->dbutil->backup();
$filename = 'easyappointments-backup-' . date('Y-m-d-His') . '.gz';
write_file(rtrim($path, '/') . '/' . $filename, $contents);
}
/**
* Trigger the synchronization of all provider calendars with Google Calendar.
*
* Use this method in a cronjob to automatically sync events between Easy!Appointments and Google Calendar.
*
* Notice:
*
* Google syncing must first be enabled for each individual provider from inside the backend calendar page.
*
* Usage:
*
* php index.php console sync
*/
public function sync()
{
$providers = $this->providers_model->get_batch();
foreach ($providers as $provider)
{
if ( ! filter_var($provider['settings']['google_sync'], FILTER_VALIDATE_BOOLEAN))
{
continue;
}
Google::sync($provider['id']);
}
}
2020-12-05 12:03:12 +03:00
/**
* Show help information about the console capabilities.
*
* Use this method to see the available commands.
*
* Usage:
*
* php index.php console help
*/
public function help()
{
$help = [
'',
'Easy!Appointments ' . config('version'),
'',
'Usage:',
'',
'⇾ php index.php console [command] [arguments]',
'',
'Commands:',
'',
'⇾ php index.php console migrate',
'⇾ php index.php console migrate fresh',
'⇾ php index.php console seed',
'⇾ php index.php console install',
'⇾ php index.php console backup',
'⇾ php index.php console sync',
'',
'',
];
$this->output->set_output(implode(PHP_EOL, $help));
}
}