ci-bonfire / Sprint

application/config/forge.php

Indentation +8 added lines, -8 removed lines

@@ -37,10 +37,10 @@ 
 // Before any _generators are run, the current environment will be
 // tested to verify it's an allowed environment.
 //
-    $config['forge.allowed_environments'] = [
-        'development',
-        'travis'
-    ];
+	$config['forge.allowed_environments'] = [
+		'development',
+		'travis'
+	];
 
 //--------------------------------------------------------------------
 // Themer to Use
@@ -48,7 +48,7 @@ 
 // Define the themer to use when rendering our template files.
 // This should include the fully namespaced classname.
 //
-    $config['forge.themer'] = '\Myth\Themers\ViewThemer';
+	$config['forge.themer'] = '\Myth\Themers\ViewThemer';
 
 //--------------------------------------------------------------------
 // Generator Collections
@@ -60,6 +60,6 @@ 
 //
 // The 'keys' are aliases that can be used to reference the view from.
 //
-    $config['forge.collections'] = [
-        'sprint'    => MYTHPATH .'_generators/'
-    ];
\ No newline at end of file
+	$config['forge.collections'] = [
+		'sprint'    => MYTHPATH .'_generators/'
+	];
\ No newline at end of file

application/third_party/HMVC/Router.php

Indentation +270 added lines, -270 removed lines

@@ -34,277 +34,277 @@
  */
 
 if (!defined("BASEPATH"))
-    exit("No direct script access allowed");
+	exit("No direct script access allowed");
 
 class HMVC_Router extends CI_Router {
 
-    /**
-     * Current module name
-     *
-     * @var string
-     * @access public
-     */
-    var $module = '';
-
-    /**
-     * Constructor
-     *
-     * Runs the route mapping function.
-     */
-    function __construct() {
-
-        $this->config =& load_class('Config', 'core');
-
-        // Process 'modules_locations' from config
-        $locations = $this->config->item('modules_locations');
-
-        if (!$locations) {
-            $locations = array(APPPATH . 'modules/');
-        } else if (!is_array($locations)) {
-            $locations = array($locations);
-        }
-
-        // Make sure all paths are the same format
-        foreach ($locations as &$location) {
-            $location = realpath($location);
-            $location = str_replace('\\', '/', $location);
-            $location = rtrim($location, '/') . '/';
-        }
-
-        $this->config->set_item('modules_locations', $locations);
-
-
-        parent::__construct();
-    }
-
-    /**
-     * Validates the supplied segments.  Attempts to determine the path to
-     * the controller.
-     *
-     * @access	private
-     * @param	array
-     * @return	array
-     */
-    function _validate_request($segments) {
-        if (count($segments) == 0) {
-            return $segments;
-        }
-
-        // Locate the controller with modules support
-        if ($located = $this->locate($segments)) {
-            return $located;
-        }
-
-        // Is there a 404 override?
-        if (!empty($this->routes['404_override'])) {
-            $segments = explode('/', $this->routes['404_override']);
-            if ($located = $this->locate($segments)) {
-                return $located;
-            }
-        }
-
-        // Nothing else to do at this point but show a 404
-        show_404($segments[0]);
-    }
-
-    /**
-     * Parse Routes
-     *
-     * This function matches any routes that may exist in
-     * the config/routes.php file against the URI to
-     * determine if the class/method need to be remapped.
-     *
-     * NOTE: The first segment must stay the name of the
-     * module, otherwise it is impossible to detect
-     * the current module in this method.
-     *
-     * @access	private
-     * @return	void
-     */
-    function _parse_routes() {
-        // Apply the current module's routing config
-
-        // CI v3.x has URI starting at segment 1
-        $segstart = (intval(substr(CI_VERSION,0,1)) > 2) ? 1 : 0;
-
-        if ($module = $this->uri->segment($segstart)) {
-            foreach ($this->config->item('modules_locations') as $location) {
-                if (is_file($file = $location . $module . '/config/routes.php')) {
-                    include ($file);
-
-                    $route = (!isset($route) or !is_array($route)) ? array() : $route;
-                    $this->routes = array_merge($this->routes, $route);
-                    unset($route);
-                }
-            }
-        }
-
-        // Let parent do the heavy routing
-        return parent::_parse_routes();
-    }
-
-    /**
-     * The logic of locating a controller is grouped in this function
-     *
-     * @param	array
-     * @return	array
-     */
-    function locate($segments) {
-        // anon function to ucfirst a string if CI ver > 2 (for backwards compatibility)
-        $_ucfirst = function($cn) {return (intval(substr(CI_VERSION,0,1)) > 2) ? ucfirst($cn) : $cn;};
-
-        list($module, $directory, $controller) = array_pad($segments, 3, NULL);
-
-        // Look for it in the standar APPPATH/controllers first so that it can override modules.
-        $c = count($segments);
-        $s = $segments;
-        // Loop through our segments and return as soon as a controller
-        // is found or when such a directory doesn't exist
-        while ($c-- > 0)
-        {
-            $test = $this->directory
-                    .ucfirst($this->translate_uri_dashes === TRUE ? str_replace('-', '_', $s[0]) : $s[0]);
-
-            if ( ! file_exists(APPPATH.'controllers/'.$test.'.php') && is_dir(APPPATH.'controllers/'.$this->directory.$s[0]))
-            {
-                $this->set_directory(array_shift($s), TRUE);
-                continue;
-            }
-            elseif (file_exists(APPPATH .'controllers/'. $test .'.php'))
-            {
-                return $s;
-            }
-        }
-
-        unset($s);
-
-        // Now look for it in all of our modules.
-        foreach ($this->config->item('modules_locations') as $location) {
-            $relative = $location;
-
-            // Make path relative to controllers directory
-            $start = rtrim(realpath(APPPATH), '/');
-            $parts = explode('/', str_replace('\\', '/', $start));
-
-            // Iterate all parts and replace absolute part with relative part
-            for ($i = 1; $i <= count($parts); $i++) {
-                $relative = str_replace(implode('/', $parts) . '/', str_repeat('../', $i), $relative, $count);
-                array_pop($parts);
-
-                // Stop iteration if found
-                if ($count)
-                    break;
-            }
-
-            // Does a module exist? (/modules/xyz/controllers/)
-            if (is_dir($source = $location . $module . '/controllers/')) {
-                $this->module = $module;
-                $this->directory = $relative . $module . '/controllers/';
-
-                // Module root controller?
-                if ($directory && is_file($source . $_ucfirst($directory) . '.php')) {
-                    $this->class = $directory;
-                    return array_slice($segments, 1);
-                }
-
-                // Module sub-directory?
-                if ($directory && is_dir($source . $directory . '/')) {
-                    $source = $source . $directory . '/';
-                    $this->directory .= $directory . '/';
-
-                    // Module sub-directory controller?
-                    if (is_file($source . $_ucfirst($directory) . '.php')) {
-                        return array_slice($segments, 1);
-                    }
-
-                    // Module sub-directory  default controller?
-                    if (is_file($source . $_ucfirst($this->default_controller) . '.php')) {
-                        $segments[1] = $this->default_controller;
-                        return array_slice($segments, 1);
-                    }
-
-                    // Module sub-directory sub-controller?
-                    if ($controller && is_file($source . $_ucfirst($controller) . '.php')) {
-                        return array_slice($segments, 2);
-                    }
-                }
-
-                // Module controller?
-                if (is_file($source . $_ucfirst($module) . '.php')) {
-                    return $segments;
-                }
-
-                // Module default controller?
-                if (is_file($source . $_ucfirst($this->default_controller) . '.php')) {
-                    $segments[0] = $this->default_controller;
-                    return $segments;
-                }
-            }
-        }
-
-        // Default controller?
-        if (is_file(APPPATH . 'controllers/' . $module . '/' . $_ucfirst($this->default_controller) . '.php')) {
-            $segments[0] = $this->default_controller;
-            return $segments;
-        }
-    }
-
-    /**
-     * Set the module name
-     *
-     * @param	string
-     * @return	void
-     */
-    function set_module($module) {
-        $this->module = $module;
-    }
-
-    /**
-     * Set default controller
-     *
-     * First we check in normal APPPATH/controller's location,
-     * then in Modules named after the default_controller
-     * @author  hArpanet - based on system/core/Router.php
-     *
-     * @return  void
-     */
-    protected function _set_default_controller()
-    {
-        // controller in APPPATH/controllers takes priority over module with same name
-        parent::_set_default_controller();
-
-        // see if parent found a controller
-        $class = $this->fetch_class();
-
-        if (empty($class)) {
-
-            // no 'normal' controller found,
-            // get the class/method from the default_controller route
-            if (sscanf($this->default_controller, '%[^/]/%s', $class, $method) !== 2)
-            {
-                $method = 'index';
-            }
-
-            // try to locate default controller in modules
-            if ($located = $this->locate(array($class, $class, $method))) {
-
-                log_message('debug', 'No URI present. Default module controller set.');
-            }
-        }
-
-        // Nothing found - this will trigger 404 later
-    }
-
-    // --------------------------------------------------------------------
-
-
-    /**
-     * Fetch the module
-     *
-     * @access	public
-     * @return	string
-     */
-    function fetch_module() {
-        return $this->module;
-    }
+	/**
+	 * Current module name
+	 *
+	 * @var string
+	 * @access public
+	 */
+	var $module = '';
+
+	/**
+	 * Constructor
+	 *
+	 * Runs the route mapping function.
+	 */
+	function __construct() {
+
+		$this->config =& load_class('Config', 'core');
+
+		// Process 'modules_locations' from config
+		$locations = $this->config->item('modules_locations');
+
+		if (!$locations) {
+			$locations = array(APPPATH . 'modules/');
+		} else if (!is_array($locations)) {
+			$locations = array($locations);
+		}
+
+		// Make sure all paths are the same format
+		foreach ($locations as &$location) {
+			$location = realpath($location);
+			$location = str_replace('\\', '/', $location);
+			$location = rtrim($location, '/') . '/';
+		}
+
+		$this->config->set_item('modules_locations', $locations);
+
+
+		parent::__construct();
+	}
+
+	/**
+	 * Validates the supplied segments.  Attempts to determine the path to
+	 * the controller.
+	 *
+	 * @access	private
+	 * @param	array
+	 * @return	array
+	 */
+	function _validate_request($segments) {
+		if (count($segments) == 0) {
+			return $segments;
+		}
+
+		// Locate the controller with modules support
+		if ($located = $this->locate($segments)) {
+			return $located;
+		}
+
+		// Is there a 404 override?
+		if (!empty($this->routes['404_override'])) {
+			$segments = explode('/', $this->routes['404_override']);
+			if ($located = $this->locate($segments)) {
+				return $located;
+			}
+		}
+
+		// Nothing else to do at this point but show a 404
+		show_404($segments[0]);
+	}
+
+	/**
+	 * Parse Routes
+	 *
+	 * This function matches any routes that may exist in
+	 * the config/routes.php file against the URI to
+	 * determine if the class/method need to be remapped.
+	 *
+	 * NOTE: The first segment must stay the name of the
+	 * module, otherwise it is impossible to detect
+	 * the current module in this method.
+	 *
+	 * @access	private
+	 * @return	void
+	 */
+	function _parse_routes() {
+		// Apply the current module's routing config
+
+		// CI v3.x has URI starting at segment 1
+		$segstart = (intval(substr(CI_VERSION,0,1)) > 2) ? 1 : 0;
+
+		if ($module = $this->uri->segment($segstart)) {
+			foreach ($this->config->item('modules_locations') as $location) {
+				if (is_file($file = $location . $module . '/config/routes.php')) {
+					include ($file);
+
+					$route = (!isset($route) or !is_array($route)) ? array() : $route;
+					$this->routes = array_merge($this->routes, $route);
+					unset($route);
+				}
+			}
+		}
+
+		// Let parent do the heavy routing
+		return parent::_parse_routes();
+	}
+
+	/**
+	 * The logic of locating a controller is grouped in this function
+	 *
+	 * @param	array
+	 * @return	array
+	 */
+	function locate($segments) {
+		// anon function to ucfirst a string if CI ver > 2 (for backwards compatibility)
+		$_ucfirst = function($cn) {return (intval(substr(CI_VERSION,0,1)) > 2) ? ucfirst($cn) : $cn;};
+
+		list($module, $directory, $controller) = array_pad($segments, 3, NULL);
+
+		// Look for it in the standar APPPATH/controllers first so that it can override modules.
+		$c = count($segments);
+		$s = $segments;
+		// Loop through our segments and return as soon as a controller
+		// is found or when such a directory doesn't exist
+		while ($c-- > 0)
+		{
+			$test = $this->directory
+					.ucfirst($this->translate_uri_dashes === TRUE ? str_replace('-', '_', $s[0]) : $s[0]);
+
+			if ( ! file_exists(APPPATH.'controllers/'.$test.'.php') && is_dir(APPPATH.'controllers/'.$this->directory.$s[0]))
+			{
+				$this->set_directory(array_shift($s), TRUE);
+				continue;
+			}
+			elseif (file_exists(APPPATH .'controllers/'. $test .'.php'))
+			{
+				return $s;
+			}
+		}
+
+		unset($s);
+
+		// Now look for it in all of our modules.
+		foreach ($this->config->item('modules_locations') as $location) {
+			$relative = $location;
+
+			// Make path relative to controllers directory
+			$start = rtrim(realpath(APPPATH), '/');
+			$parts = explode('/', str_replace('\\', '/', $start));
+
+			// Iterate all parts and replace absolute part with relative part
+			for ($i = 1; $i <= count($parts); $i++) {
+				$relative = str_replace(implode('/', $parts) . '/', str_repeat('../', $i), $relative, $count);
+				array_pop($parts);
+
+				// Stop iteration if found
+				if ($count)
+					break;
+			}
+
+			// Does a module exist? (/modules/xyz/controllers/)
+			if (is_dir($source = $location . $module . '/controllers/')) {
+				$this->module = $module;
+				$this->directory = $relative . $module . '/controllers/';
+
+				// Module root controller?
+				if ($directory && is_file($source . $_ucfirst($directory) . '.php')) {
+					$this->class = $directory;
+					return array_slice($segments, 1);
+				}
+
+				// Module sub-directory?
+				if ($directory && is_dir($source . $directory . '/')) {
+					$source = $source . $directory . '/';
+					$this->directory .= $directory . '/';
+
+					// Module sub-directory controller?
+					if (is_file($source . $_ucfirst($directory) . '.php')) {
+						return array_slice($segments, 1);
+					}
+
+					// Module sub-directory  default controller?
+					if (is_file($source . $_ucfirst($this->default_controller) . '.php')) {
+						$segments[1] = $this->default_controller;
+						return array_slice($segments, 1);
+					}
+
+					// Module sub-directory sub-controller?
+					if ($controller && is_file($source . $_ucfirst($controller) . '.php')) {
+						return array_slice($segments, 2);
+					}
+				}
+
+				// Module controller?
+				if (is_file($source . $_ucfirst($module) . '.php')) {
+					return $segments;
+				}
+
+				// Module default controller?
+				if (is_file($source . $_ucfirst($this->default_controller) . '.php')) {
+					$segments[0] = $this->default_controller;
+					return $segments;
+				}
+			}
+		}
+
+		// Default controller?
+		if (is_file(APPPATH . 'controllers/' . $module . '/' . $_ucfirst($this->default_controller) . '.php')) {
+			$segments[0] = $this->default_controller;
+			return $segments;
+		}
+	}
+
+	/**
+	 * Set the module name
+	 *
+	 * @param	string
+	 * @return	void
+	 */
+	function set_module($module) {
+		$this->module = $module;
+	}
+
+	/**
+	 * Set default controller
+	 *
+	 * First we check in normal APPPATH/controller's location,
+	 * then in Modules named after the default_controller
+	 * @author  hArpanet - based on system/core/Router.php
+	 *
+	 * @return  void
+	 */
+	protected function _set_default_controller()
+	{
+		// controller in APPPATH/controllers takes priority over module with same name
+		parent::_set_default_controller();
+
+		// see if parent found a controller
+		$class = $this->fetch_class();
+
+		if (empty($class)) {
+
+			// no 'normal' controller found,
+			// get the class/method from the default_controller route
+			if (sscanf($this->default_controller, '%[^/]/%s', $class, $method) !== 2)
+			{
+				$method = 'index';
+			}
+
+			// try to locate default controller in modules
+			if ($located = $this->locate(array($class, $class, $method))) {
+
+				log_message('debug', 'No URI present. Default module controller set.');
+			}
+		}
+
+		// Nothing found - this will trigger 404 later
+	}
+
+	// --------------------------------------------------------------------
+
+
+	/**
+	 * Fetch the module
+	 *
+	 * @access	public
+	 * @return	string
+	 */
+	function fetch_module() {
+		return $this->module;
+	}
 }

myth/CIModules/docs/controllers/Docs.php

Indentation +259 added lines, -259 removed lines

@@ -33,284 +33,284 @@
 class Docs extends \Myth\Controllers\ThemedController
 {
 
-    protected $ignoreFiles = array('_404.md');
+	protected $ignoreFiles = array('_404.md');
 
-    protected $tocFile;
+	protected $tocFile;
 
-    protected $doc_folders = [];
+	protected $doc_folders = [];
 
-    protected $current_group = null;
+	protected $current_group = null;
 
-    protected $current_path = null;
+	protected $current_path = null;
 
-    private $showAppDocs;
+	private $showAppDocs;
 
-    private $showDevDocs;
+	private $showDevDocs;
 
-    protected $theme = 'docs';
+	protected $theme = 'docs';
 
-    protected $auto_escape = false;
+	protected $auto_escape = false;
 
-    //--------------------------------------------------------------------------
+	//--------------------------------------------------------------------------
 
-    /**
-     * Constructor
-     *
-     * @return \Docs
-     */
-    public function __construct()
-    {
-        parent::__construct();
+	/**
+	 * Constructor
+	 *
+	 * @return \Docs
+	 */
+	public function __construct()
+	{
+		parent::__construct();
 
-        $this->load->config('docs');
-        $this->lang->load('docs');
+		$this->load->config('docs');
+		$this->lang->load('docs');
 
-        // Save our folders
-        $this->doc_folders = config_item('docs.folders');
+		// Save our folders
+		$this->doc_folders = config_item('docs.folders');
 
-        list($this->current_group, $this->current_path) = $this->determineFromURL();
+		list($this->current_group, $this->current_path) = $this->determineFromURL();
 
-        $this->determineVisibleGroups($this->current_group, $this->current_path);
+		$this->determineVisibleGroups($this->current_group, $this->current_path);
 
-        $this->load->helper('form');
-        $this->load->helper('language');
+		$this->load->helper('form');
+		$this->load->helper('language');
 
-        $this->docbuilder = new \Myth\Docs\Builder( array('apppath' => APPPATH) );
+		$this->docbuilder = new \Myth\Docs\Builder( array('apppath' => APPPATH) );
 
-        $formatter = function ($str) {
-            $converter = new \League\CommonMark\CommonMarkConverter();
-            return $converter->convertToHtml($str);
-        };
-        $this->docbuilder->registerFormatter($formatter, true);
-    }
+		$formatter = function ($str) {
+			$converter = new \League\CommonMark\CommonMarkConverter();
+			return $converter->convertToHtml($str);
+		};
+		$this->docbuilder->registerFormatter($formatter, true);
+	}
 
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
 
-    /**
-     * Display the list of documents available and the current document
-     *
-     * @return void
-     */
-    public function index()
-    {
-        $data = array();
+	/**
+	 * Display the list of documents available and the current document
+	 *
+	 * @return void
+	 */
+	public function index()
+	{
+		$data = array();
 
-        // Make sure the builder knows where to look
-        foreach ($this->doc_folders as $alias => $folder) {
-            $this->docbuilder->addDocFolder($alias, $folder);
-        }
-
-        try {
-            $content = $this->docbuilder->readPage($this->current_path, $this->current_group);
-            $content = $this->docbuilder->postProcess($content, site_url(), current_url());
-
-            $data['sidebar'] = $this->buildSidebar($content);
-            $data['toc']     = $this->buildTOC();
-            $data['content'] = $content;
-            $data['page_title'] = $this->docbuilder->pageTitle();
-        } catch (Exception $e) {
-            $this->setMessage($e->getMessage(), 'warning');
-        }
-
-        $this->render($data, config_item('docs.cache_time'));
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Display search results and handles the search itself.
-     *
-     * @return void
-     */
-    public function search()
-    {
-        $this->benchmark->mark('search_start');
-        $this->docsearch = new \Myth\Docs\Search();
-        $this->load->helper('markdown_extended');
-        $this->docsearch->registerFormatter('MarkdownExtended', true);
-
-        $data = array();
-
-        $terms = $this->input->post('search_terms');
-
-        if ($terms) {
-            $search_folders = $this->doc_folders;
-
-            $data['results'] = $this->docsearch->search($terms, $search_folders);
-        }
-
-        $this->benchmark->mark('search_end');
-
-        $data['search_time']  = $this->benchmark->elapsed_time('search_start', 'search_end');
-        $data['search_terms'] = $terms;
-        $data['page_title'] = 'Search Results';
-
-        $this->render($data);
-    }
-
-    //--------------------------------------------------------------------------
-    // Private Methods
-    //--------------------------------------------------------------------------
-
-    /**
-     * Determines which groups are allowed to be viewed by the current system
-     * and the user/environment.
-     *
-     * todo Allow docs groups to be shown/hidden per-environment, using assoc-array for permitted environments
-     */
-    private function determineVisibleGroups($current_group, $current_path)
-    {
-        // Is displaying docs permitted for this environment?
-        if (config_item('docs.permitted_environments')
-            && !in_array(ENVIRONMENT, config_item('docs.permitted_environments'))
-        ) {
-            $this->setMessage(lang('docs_env_disabled'), 'danger');
-            redirect();
-        }
-
-        $this->showAppDocs = config_item('docs.show_app_docs');
-        $this->showDevDocs = config_item('docs.show_dev_docs');
-        $this->tocFile     = config_item('docs.toc_file') ?: '_toc.ini';
-
-        // Make sure we can still get to the search method.
-        if ($current_group == 'search') {
-            $this->current_group = false;
-        } // Are we allowed to show developer docs in this environment?
-        elseif ($current_group == 'developer'
-                && !$this->showDevDocs
-                && ENVIRONMENT != 'development'
-        ) {
-            if ($this->showAppDocs) {
-                $this->setMessage(lang('docs_not_allowed_dev'), 'warning');
-
-                redirect('docs/application');
-            }
-
-            show_error(lang('docs_not_allowed'));
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Determines the current doc group and file path from the current URL.
-     *
-     * Returns an array with the group and file path in the 0 and 1 positions, respectively.
-     *
-     * @return array
-     */
-    private function determineFromURL()
-    {
-        $return = [
-            '', // Group
-            '', // File Path
-        ];
-
-        $segments = $this->uri->segment_array();
-
-        // Remove the 'docs' from the array
-        // for now, we assume this is the first one
-        // since that is how Bonfire is setup to show docs
-        // @todo Make it so the path can be modified and this still works.
-        array_shift($segments);
-
-        // If nothing left, then assign the default group and redirect to
-        // a page we can do something with...
-        if (!count($segments)) {
-            redirect('docs/' . config_item('docs.default_group'));
-        }
-
-        // Do we have a group specified? Bonfire Docs requires that a group
-        // be part of the URI so it should be the first element on the array.
-        $return[0] = array_shift($segments);
-
-        // If there's any more left, then join them together and they'll
-        // form the path to the file. This will allow for subfolders with the
-        // docs folder itself.
-        $return[1] = count($segments) ? implode('/', $segments) : 'index';
-
-        return $return;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Builds a TOC for the sidebar out of files found in the following folders:
-     *      - application/docs
-     *      - bonfire/docs
-     *      - {module}/docs
-     *
-     * @param $content  The HTML generated for the page content.
-     * @return string   The HTML for the sidebar.
-     */
-    private function buildSidebar(&$content)
-    {
-        $data = [];
-
-        // Set the remaining data for the view
-        $data['docsDir'] = 'docs/' . $this->current_group . '/';
-        $data['docsExt'] = config_item('docs.extension');
-
-        $data['docMap'] = $this->docbuilder->buildDocumentMap($content);
-
-        return $this->docbuilder->postProcess(
-            $this->load->view('docs/_document_map', $data, true),
-            site_url(),
-            current_url()
-        );
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Builds out the nested lists of items that are needed
-     */
-    private function buildTOC()
-    {
-        $folder = $this->doc_folders[$this->current_group] . '/';
-
-        $map = $this->docbuilder->buildTOC($folder);
-
-        return $this->docbuilder->postProcess(
-            $this->load->view('docs/_toc', ['map' => $map], true),
-            site_url(),
-            current_url()
-        );
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Checks all modules to see if they include docs and prepares their doc
-     * information for use in the sidebar.
-     *
-     * @return array
-     */
-    private function get_module_docs()
-    {
-        $docs_modules = array();
-        foreach (\Bonfire\Modules::list_modules() as $module) {
-            $ignored_folders = array();
-            $path            = \Bonfire\Modules::path($module) . $this->docsDir;
-
-            // If these are developer docs, add the folder to the path.
-            if ($this->current_group == $this->docsTypeBf) {
-                $path .= '/' . $this->docsTypeBf;
-            } // For Application docs, ignore the 'developers' folder.
-            else {
-                $ignored_folders[] = $this->docsTypeBf;
-            }
-
-            if (is_dir($path)) {
-                $files = $this->get_folder_files($path, $module, $ignored_folders);
-                if (is_array($files) && count($files)) {
-                    $docs_modules[$module] = $files;
-                }
-            }
-        }
-
-        return $docs_modules;
-    }
-    //--------------------------------------------------------------------
+		// Make sure the builder knows where to look
+		foreach ($this->doc_folders as $alias => $folder) {
+			$this->docbuilder->addDocFolder($alias, $folder);
+		}
+
+		try {
+			$content = $this->docbuilder->readPage($this->current_path, $this->current_group);
+			$content = $this->docbuilder->postProcess($content, site_url(), current_url());
+
+			$data['sidebar'] = $this->buildSidebar($content);
+			$data['toc']     = $this->buildTOC();
+			$data['content'] = $content;
+			$data['page_title'] = $this->docbuilder->pageTitle();
+		} catch (Exception $e) {
+			$this->setMessage($e->getMessage(), 'warning');
+		}
+
+		$this->render($data, config_item('docs.cache_time'));
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Display search results and handles the search itself.
+	 *
+	 * @return void
+	 */
+	public function search()
+	{
+		$this->benchmark->mark('search_start');
+		$this->docsearch = new \Myth\Docs\Search();
+		$this->load->helper('markdown_extended');
+		$this->docsearch->registerFormatter('MarkdownExtended', true);
+
+		$data = array();
+
+		$terms = $this->input->post('search_terms');
+
+		if ($terms) {
+			$search_folders = $this->doc_folders;
+
+			$data['results'] = $this->docsearch->search($terms, $search_folders);
+		}
+
+		$this->benchmark->mark('search_end');
+
+		$data['search_time']  = $this->benchmark->elapsed_time('search_start', 'search_end');
+		$data['search_terms'] = $terms;
+		$data['page_title'] = 'Search Results';
+
+		$this->render($data);
+	}
+
+	//--------------------------------------------------------------------------
+	// Private Methods
+	//--------------------------------------------------------------------------
+
+	/**
+	 * Determines which groups are allowed to be viewed by the current system
+	 * and the user/environment.
+	 *
+	 * todo Allow docs groups to be shown/hidden per-environment, using assoc-array for permitted environments
+	 */
+	private function determineVisibleGroups($current_group, $current_path)
+	{
+		// Is displaying docs permitted for this environment?
+		if (config_item('docs.permitted_environments')
+			&& !in_array(ENVIRONMENT, config_item('docs.permitted_environments'))
+		) {
+			$this->setMessage(lang('docs_env_disabled'), 'danger');
+			redirect();
+		}
+
+		$this->showAppDocs = config_item('docs.show_app_docs');
+		$this->showDevDocs = config_item('docs.show_dev_docs');
+		$this->tocFile     = config_item('docs.toc_file') ?: '_toc.ini';
+
+		// Make sure we can still get to the search method.
+		if ($current_group == 'search') {
+			$this->current_group = false;
+		} // Are we allowed to show developer docs in this environment?
+		elseif ($current_group == 'developer'
+				&& !$this->showDevDocs
+				&& ENVIRONMENT != 'development'
+		) {
+			if ($this->showAppDocs) {
+				$this->setMessage(lang('docs_not_allowed_dev'), 'warning');
+
+				redirect('docs/application');
+			}
+
+			show_error(lang('docs_not_allowed'));
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Determines the current doc group and file path from the current URL.
+	 *
+	 * Returns an array with the group and file path in the 0 and 1 positions, respectively.
+	 *
+	 * @return array
+	 */
+	private function determineFromURL()
+	{
+		$return = [
+			'', // Group
+			'', // File Path
+		];
+
+		$segments = $this->uri->segment_array();
+
+		// Remove the 'docs' from the array
+		// for now, we assume this is the first one
+		// since that is how Bonfire is setup to show docs
+		// @todo Make it so the path can be modified and this still works.
+		array_shift($segments);
+
+		// If nothing left, then assign the default group and redirect to
+		// a page we can do something with...
+		if (!count($segments)) {
+			redirect('docs/' . config_item('docs.default_group'));
+		}
+
+		// Do we have a group specified? Bonfire Docs requires that a group
+		// be part of the URI so it should be the first element on the array.
+		$return[0] = array_shift($segments);
+
+		// If there's any more left, then join them together and they'll
+		// form the path to the file. This will allow for subfolders with the
+		// docs folder itself.
+		$return[1] = count($segments) ? implode('/', $segments) : 'index';
+
+		return $return;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Builds a TOC for the sidebar out of files found in the following folders:
+	 *      - application/docs
+	 *      - bonfire/docs
+	 *      - {module}/docs
+	 *
+	 * @param $content  The HTML generated for the page content.
+	 * @return string   The HTML for the sidebar.
+	 */
+	private function buildSidebar(&$content)
+	{
+		$data = [];
+
+		// Set the remaining data for the view
+		$data['docsDir'] = 'docs/' . $this->current_group . '/';
+		$data['docsExt'] = config_item('docs.extension');
+
+		$data['docMap'] = $this->docbuilder->buildDocumentMap($content);
+
+		return $this->docbuilder->postProcess(
+			$this->load->view('docs/_document_map', $data, true),
+			site_url(),
+			current_url()
+		);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Builds out the nested lists of items that are needed
+	 */
+	private function buildTOC()
+	{
+		$folder = $this->doc_folders[$this->current_group] . '/';
+
+		$map = $this->docbuilder->buildTOC($folder);
+
+		return $this->docbuilder->postProcess(
+			$this->load->view('docs/_toc', ['map' => $map], true),
+			site_url(),
+			current_url()
+		);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Checks all modules to see if they include docs and prepares their doc
+	 * information for use in the sidebar.
+	 *
+	 * @return array
+	 */
+	private function get_module_docs()
+	{
+		$docs_modules = array();
+		foreach (\Bonfire\Modules::list_modules() as $module) {
+			$ignored_folders = array();
+			$path            = \Bonfire\Modules::path($module) . $this->docsDir;
+
+			// If these are developer docs, add the folder to the path.
+			if ($this->current_group == $this->docsTypeBf) {
+				$path .= '/' . $this->docsTypeBf;
+			} // For Application docs, ignore the 'developers' folder.
+			else {
+				$ignored_folders[] = $this->docsTypeBf;
+			}
+
+			if (is_dir($path)) {
+				$files = $this->get_folder_files($path, $module, $ignored_folders);
+				if (is_array($files) && count($files)) {
+					$docs_modules[$module] = $files;
+				}
+			}
+		}
+
+		return $docs_modules;
+	}
+	//--------------------------------------------------------------------
 
 }

myth/Settings/Settings.php

Indentation +248 added lines, -248 removed lines

@@ -40,253 +40,253 @@
  */
 class Settings {
 
-    /**
-     * Holds instantiated data stores.
-     *
-     * @var array
-     */
-    protected static $stores = [];
-
-    protected static $default_store = '';
-
-    protected static $initialized = false;
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Fires up instances of the datastores and gets us ready to roll.
-     */
-    public static function init()
-    {
-        if (self::$initialized === true)
-        {
-            return;
-        }
-
-        // Load up and instantiate our setting stores.
-        $user_stores = config_item('settings.stores');
-
-        if (is_array($user_stores))
-        {
-            foreach ($user_stores as $alias => $class)
-            {
-                self::$stores[ strtolower($alias) ] = new $class();
-            }
-        }
-
-        self::$default_store = config_item('settings.default_store');
-
-        if (empty(self::$stores[ self::$default_store ]))
-        {
-            show_error( lang('settings.bad_default') );
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Inserts/Replaces a single setting item.
-     *
-     * @param $key
-     * @param null $value
-     * @param string $group
-     * @param string $store
-     */
-    public static function save($key, $value=null, $group='app', $store=null)
-    {
-        self::init();
-
-        if (empty($store) || empty(self::$stores[$store]))
-        {
-            // we've already determined that the default store exists
-            // in the init() method.
-            $store = self::$default_store;
-        }
-
-        return self::$stores[ $store ]->save($key, $value, $group);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Retrieves a single item. If not $store is specified, will loop
-     * through the stores in order until it finds it. If $store is
-     * specified, will only look within that store for it.
-     *
-     * @param $key
-     * @param string $group
-     * @param string $store
-     * @return mixed
-     */
-    public static function get($key, $group='app', $store=null)
-    {
-        self::init();
-
-        $group = strtolower($group);
-
-        // If the store is specified but doesn't exist, crap out
-        // so that they developer has a chance to fix it.
-        if (! is_null($store) && empty(self::$stores[$store]))
-        {
-            show_error( sprintf( lang('settings.cant_retrieve'), $store ) );
-        }
-
-        // If $store is set, get the value from that store only.
-        if (! empty($store))
-        {
-            return self::$stores[$store]->get($key, $group);
-        }
-
-        // Otherwise loop through each store until we find it
-        foreach (self::$stores as $s)
-        {
-            if ($found = $s->get($key, $group))
-            {
-                return $found;
-            }
-        }
-
-        // Still here... guess we didn't find anything, then...
-        return false;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Deletes a single item.
-     *
-     * @param $key
-     * @param $group
-     * @param $store
-     * @return mixed
-     */
-    public static function delete($key, $group='app', $store=null)
-    {
-        self::init();
-
-        $group = strtolower($group);
-
-        // If the store is specified but doesn't exist, crap out
-        // so that they developer has a chance to fix it.
-        if (! is_null($store) && empty(self::$stores[$store]))
-        {
-            show_error( sprintf( lang('settings.cant_retrieve'), $store ) );
-        }
-
-        // If $store is set, get the value from that store only.
-        if (! empty($store))
-        {
-            return self::$stores[$store]->delete($key, $group);
-        }
-
-        // Otherwise delete from the default store
-        return self::$stores[ self::$default_store ]->delete($key, $group);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Searches the store for any items with $field = $value.
-     *
-     * @param $field
-     * @param $value
-     * @return mixed
-     */
-    public static function findBy($field, $value)
-    {
-        self::init();
-
-        foreach (self::$stores as $s)
-        {
-            if ($found = $s->findBy($field, $value))
-            {
-                return $found;
-            }
-        }
-
-        return false;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Retrieves all items in the store either globally or for a single group.
-     *
-     * @param string $group
-     * @return mixed
-     */
-    public static function all($group=null, $store=null)
-    {
-        self::init();
-
-        $group = strtolower($group);
-
-        if (! empty($store))
-        {
-            return self::$stores[ $store ]->all($group);
-        }
-
-        // Otherwise combine the results from all stores
-        $results = [];
-
-        foreach (self::$stores as $s)
-        {
-            $found = $s->all($group);
-            if ($found)
-            {
-                $results = array_merge($results, (array)$found);
-            }
-        }
-
-        return $results;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Appends a new datastore the end of the curent stores.
-     *
-     * @param $alias
-     * @param $class
-     * @return bool
-     */
-    public static function addStore($alias, $class)
-    {
-        self::init();
-
-        if (class_exists($class))
-        {
-            self::$stores[ strtolower($alias) ] = new $class();
-            return true;
-        }
-
-        return false;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Removes a datastore from the list of stores currently available.
-     *
-     * @param $alias
-     * @return bool
-     */
-    public static function removeStore($alias)
-    {
-        self::init();
-
-        $alias = strtolower($alias);
-
-        if (empty(self::$stores[$alias]))
-        {
-            return false;
-        }
-
-        unset(self::$stores[$alias]);
-
-        return true;
-    }
-
-    //--------------------------------------------------------------------
+	/**
+	 * Holds instantiated data stores.
+	 *
+	 * @var array
+	 */
+	protected static $stores = [];
+
+	protected static $default_store = '';
+
+	protected static $initialized = false;
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Fires up instances of the datastores and gets us ready to roll.
+	 */
+	public static function init()
+	{
+		if (self::$initialized === true)
+		{
+			return;
+		}
+
+		// Load up and instantiate our setting stores.
+		$user_stores = config_item('settings.stores');
+
+		if (is_array($user_stores))
+		{
+			foreach ($user_stores as $alias => $class)
+			{
+				self::$stores[ strtolower($alias) ] = new $class();
+			}
+		}
+
+		self::$default_store = config_item('settings.default_store');
+
+		if (empty(self::$stores[ self::$default_store ]))
+		{
+			show_error( lang('settings.bad_default') );
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Inserts/Replaces a single setting item.
+	 *
+	 * @param $key
+	 * @param null $value
+	 * @param string $group
+	 * @param string $store
+	 */
+	public static function save($key, $value=null, $group='app', $store=null)
+	{
+		self::init();
+
+		if (empty($store) || empty(self::$stores[$store]))
+		{
+			// we've already determined that the default store exists
+			// in the init() method.
+			$store = self::$default_store;
+		}
+
+		return self::$stores[ $store ]->save($key, $value, $group);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Retrieves a single item. If not $store is specified, will loop
+	 * through the stores in order until it finds it. If $store is
+	 * specified, will only look within that store for it.
+	 *
+	 * @param $key
+	 * @param string $group
+	 * @param string $store
+	 * @return mixed
+	 */
+	public static function get($key, $group='app', $store=null)
+	{
+		self::init();
+
+		$group = strtolower($group);
+
+		// If the store is specified but doesn't exist, crap out
+		// so that they developer has a chance to fix it.
+		if (! is_null($store) && empty(self::$stores[$store]))
+		{
+			show_error( sprintf( lang('settings.cant_retrieve'), $store ) );
+		}
+
+		// If $store is set, get the value from that store only.
+		if (! empty($store))
+		{
+			return self::$stores[$store]->get($key, $group);
+		}
+
+		// Otherwise loop through each store until we find it
+		foreach (self::$stores as $s)
+		{
+			if ($found = $s->get($key, $group))
+			{
+				return $found;
+			}
+		}
+
+		// Still here... guess we didn't find anything, then...
+		return false;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Deletes a single item.
+	 *
+	 * @param $key
+	 * @param $group
+	 * @param $store
+	 * @return mixed
+	 */
+	public static function delete($key, $group='app', $store=null)
+	{
+		self::init();
+
+		$group = strtolower($group);
+
+		// If the store is specified but doesn't exist, crap out
+		// so that they developer has a chance to fix it.
+		if (! is_null($store) && empty(self::$stores[$store]))
+		{
+			show_error( sprintf( lang('settings.cant_retrieve'), $store ) );
+		}
+
+		// If $store is set, get the value from that store only.
+		if (! empty($store))
+		{
+			return self::$stores[$store]->delete($key, $group);
+		}
+
+		// Otherwise delete from the default store
+		return self::$stores[ self::$default_store ]->delete($key, $group);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Searches the store for any items with $field = $value.
+	 *
+	 * @param $field
+	 * @param $value
+	 * @return mixed
+	 */
+	public static function findBy($field, $value)
+	{
+		self::init();
+
+		foreach (self::$stores as $s)
+		{
+			if ($found = $s->findBy($field, $value))
+			{
+				return $found;
+			}
+		}
+
+		return false;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Retrieves all items in the store either globally or for a single group.
+	 *
+	 * @param string $group
+	 * @return mixed
+	 */
+	public static function all($group=null, $store=null)
+	{
+		self::init();
+
+		$group = strtolower($group);
+
+		if (! empty($store))
+		{
+			return self::$stores[ $store ]->all($group);
+		}
+
+		// Otherwise combine the results from all stores
+		$results = [];
+
+		foreach (self::$stores as $s)
+		{
+			$found = $s->all($group);
+			if ($found)
+			{
+				$results = array_merge($results, (array)$found);
+			}
+		}
+
+		return $results;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Appends a new datastore the end of the curent stores.
+	 *
+	 * @param $alias
+	 * @param $class
+	 * @return bool
+	 */
+	public static function addStore($alias, $class)
+	{
+		self::init();
+
+		if (class_exists($class))
+		{
+			self::$stores[ strtolower($alias) ] = new $class();
+			return true;
+		}
+
+		return false;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Removes a datastore from the list of stores currently available.
+	 *
+	 * @param $alias
+	 * @return bool
+	 */
+	public static function removeStore($alias)
+	{
+		self::init();
+
+		$alias = strtolower($alias);
+
+		if (empty(self::$stores[$alias]))
+		{
+			return false;
+		}
+
+		unset(self::$stores[$alias]);
+
+		return true;
+	}
+
+	//--------------------------------------------------------------------
 
 }

myth/Mail/LogMailService.php

Indentation +285 added lines, -285 removed lines

@@ -40,289 +40,289 @@
  */
 class LogMailService implements MailServiceInterface {
 
-    protected $ci = null;
-
-    protected $format = 'html';
-    protected $headers = [];
-    protected $subject = null;
-
-    protected $html_message = null;
-    protected $text_message = null;
-
-    //--------------------------------------------------------------------
-
-    public function __construct()
-    {
-        $this->ci =& get_instance();
-
-        $this->ci->load->library('email');
-    }
-
-    //--------------------------------------------------------------------
-
-
-    /**
-     * Does the actual delivery of a message. In this case, though, we simply
-     * write the html and text files out to the log folder/emails.
-     *
-     * The filename format is: yyyymmddhhiiss_email.{format}
-     *
-     * @param bool  $clear_after    If TRUE, will reset the class after sending.
-     *
-     * @return mixed
-     */
-    public function send($clear_after=true)
-    {
-
-        // Ensure we have enough data
-        if (empty($this->to) || empty($this->subject) ||
-            (empty($this->html_message) && empty($this->text_message))
-        )
-        {
-            throw new \RuntimeException( lang('mail.invalid_log_data') );
-        }
-
-        $symbols = ['#', '%', '&', '{', '}', '\\', '/', '<', '>', '*', '?', ' ', '$', '!', '\'', '"', ':', '@', '+', '`', '='];
-
-        $email = str_replace($symbols, '.', strtolower($this->to) );
-
-        $filename = date('YmdHis_'). $email;
-
-        // Ensure the emails folder exists in the log folder.
-        $path = config_item('log_path');
-        $path = ! empty( $path ) ? $path : APPPATH .'logs/';
-        $path = rtrim($path, '/ ') .'/email/';
-
-        if (! is_dir($path))
-        {
-            mkdir($path, 0777, true);
-        }
-
-        get_instance()->load->helper('file');
-
-        // Write our HTML file out
-        if (! empty($this->html_message) && ! write_file( $path . $filename . '.html', $this->html_message ) )
-        {
-            throw new \RuntimeException( sprintf( lang('mail.error_html_log'), $path, $filename) );
-        }
-
-        // Write our TEXT file out
-        if (! empty($this->text_message) && ! write_file( $path . $filename . '.txt', $this->text_message ) )
-        {
-            throw new \RuntimeException( sprintf( lang('mail.error_text_log'), $path, $filename) );
-        }
-
-        return true;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Adds an attachment to the current email that is being built.
-     *
-     * @param string    $filename
-     * @param string    $disposition    like 'inline'. Default is 'attachment'
-     * @param string    $newname        If you'd like to rename the file for delivery
-     * @param string    $mime           Custom defined mime type.
-     */
-    public function attach($filename, $disposition=null, $newname=null, $mime=null)
-    {
-        return;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets a header value for the email. Not every service will provide this.
-     *
-     * @param $field
-     * @param $value
-     * @return mixed
-     */
-    public function setHeader($field, $value)
-    {
-        $this->headers[$field] = $value;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Options
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the email address to send the email to.
-     *
-     * @param $email
-     * @return mixed
-     */
-    public function to($email)
-    {
-        $this->to = $email;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets who the email is coming from.
-     *
-     * @param $email
-     * @param null $name
-     * @return mixed
-     */
-    public function from($email, $name=null)
-    {
-        if (! empty($name))
-        {
-            $this->from = [$email, $name];
-        }
-        else
-        {
-            $this->from = $email;
-        }
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets a single additional email address to 'cc'.
-     *
-     * @param $email
-     * @return mixed
-     */
-    public function cc($email)
-    {
-        $this->cc = $email;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets a single email address to 'bcc' to.
-     *
-     * @param $email
-     * @return mixed
-     */
-    public function bcc($email)
-    {
-        $this->bcc = $email;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the reply to address.
-     *
-     * @param $email
-     * @return mixed
-     */
-    public function reply_to($email, $name=null)
-    {
-        if (! empty($name))
-        {
-            $this->reply_to = [$email, $name];
-        }
-        else
-        {
-            $this->reply_to = $email;
-        }
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the subject line of the email.
-     *
-     * @param $subject
-     * @return mixed
-     */
-    public function subject($subject)
-    {
-        $this->subject = $subject;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the HTML portion of the email address. Optional.
-     *
-     * @param $message
-     * @return mixed
-     */
-    public function html_message($message)
-    {
-        $this->html_message = $message;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the text portion of the email address. Optional.
-     *
-     * @param $message
-     * @return mixed
-     */
-    public function text_message($message)
-    {
-        $this->text_message = $message;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the format to send the email in. Either 'html' or 'text'.
-     *
-     * @param $format
-     * @return mixed
-     */
-    public function format($format)
-    {
-        $this->format = $format;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-    /**
-     * Resets the state to blank, ready for a new email. Useful when
-     * sending emails in a loop and you need to make sure that the
-     * email is reset.
-     *
-     * @param bool $clear_attachments
-     * @return mixed
-     */
-    public function reset($clear_attachments=true)
-    {
-        $this->to = null;
-        $this->from = null;
-        $this->reply_to = null;
-        $this->cc = null;
-        $this->bcc = null;
-        $this->subject = null;
-        $this->html_message = null;
-        $this->text_message = null;
-        $this->headers = [];
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
+	protected $ci = null;
+
+	protected $format = 'html';
+	protected $headers = [];
+	protected $subject = null;
+
+	protected $html_message = null;
+	protected $text_message = null;
+
+	//--------------------------------------------------------------------
+
+	public function __construct()
+	{
+		$this->ci =& get_instance();
+
+		$this->ci->load->library('email');
+	}
+
+	//--------------------------------------------------------------------
+
+
+	/**
+	 * Does the actual delivery of a message. In this case, though, we simply
+	 * write the html and text files out to the log folder/emails.
+	 *
+	 * The filename format is: yyyymmddhhiiss_email.{format}
+	 *
+	 * @param bool  $clear_after    If TRUE, will reset the class after sending.
+	 *
+	 * @return mixed
+	 */
+	public function send($clear_after=true)
+	{
+
+		// Ensure we have enough data
+		if (empty($this->to) || empty($this->subject) ||
+			(empty($this->html_message) && empty($this->text_message))
+		)
+		{
+			throw new \RuntimeException( lang('mail.invalid_log_data') );
+		}
+
+		$symbols = ['#', '%', '&', '{', '}', '\\', '/', '<', '>', '*', '?', ' ', '$', '!', '\'', '"', ':', '@', '+', '`', '='];
+
+		$email = str_replace($symbols, '.', strtolower($this->to) );
+
+		$filename = date('YmdHis_'). $email;
+
+		// Ensure the emails folder exists in the log folder.
+		$path = config_item('log_path');
+		$path = ! empty( $path ) ? $path : APPPATH .'logs/';
+		$path = rtrim($path, '/ ') .'/email/';
+
+		if (! is_dir($path))
+		{
+			mkdir($path, 0777, true);
+		}
+
+		get_instance()->load->helper('file');
+
+		// Write our HTML file out
+		if (! empty($this->html_message) && ! write_file( $path . $filename . '.html', $this->html_message ) )
+		{
+			throw new \RuntimeException( sprintf( lang('mail.error_html_log'), $path, $filename) );
+		}
+
+		// Write our TEXT file out
+		if (! empty($this->text_message) && ! write_file( $path . $filename . '.txt', $this->text_message ) )
+		{
+			throw new \RuntimeException( sprintf( lang('mail.error_text_log'), $path, $filename) );
+		}
+
+		return true;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Adds an attachment to the current email that is being built.
+	 *
+	 * @param string    $filename
+	 * @param string    $disposition    like 'inline'. Default is 'attachment'
+	 * @param string    $newname        If you'd like to rename the file for delivery
+	 * @param string    $mime           Custom defined mime type.
+	 */
+	public function attach($filename, $disposition=null, $newname=null, $mime=null)
+	{
+		return;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets a header value for the email. Not every service will provide this.
+	 *
+	 * @param $field
+	 * @param $value
+	 * @return mixed
+	 */
+	public function setHeader($field, $value)
+	{
+		$this->headers[$field] = $value;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Options
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the email address to send the email to.
+	 *
+	 * @param $email
+	 * @return mixed
+	 */
+	public function to($email)
+	{
+		$this->to = $email;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets who the email is coming from.
+	 *
+	 * @param $email
+	 * @param null $name
+	 * @return mixed
+	 */
+	public function from($email, $name=null)
+	{
+		if (! empty($name))
+		{
+			$this->from = [$email, $name];
+		}
+		else
+		{
+			$this->from = $email;
+		}
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets a single additional email address to 'cc'.
+	 *
+	 * @param $email
+	 * @return mixed
+	 */
+	public function cc($email)
+	{
+		$this->cc = $email;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets a single email address to 'bcc' to.
+	 *
+	 * @param $email
+	 * @return mixed
+	 */
+	public function bcc($email)
+	{
+		$this->bcc = $email;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the reply to address.
+	 *
+	 * @param $email
+	 * @return mixed
+	 */
+	public function reply_to($email, $name=null)
+	{
+		if (! empty($name))
+		{
+			$this->reply_to = [$email, $name];
+		}
+		else
+		{
+			$this->reply_to = $email;
+		}
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the subject line of the email.
+	 *
+	 * @param $subject
+	 * @return mixed
+	 */
+	public function subject($subject)
+	{
+		$this->subject = $subject;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the HTML portion of the email address. Optional.
+	 *
+	 * @param $message
+	 * @return mixed
+	 */
+	public function html_message($message)
+	{
+		$this->html_message = $message;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the text portion of the email address. Optional.
+	 *
+	 * @param $message
+	 * @return mixed
+	 */
+	public function text_message($message)
+	{
+		$this->text_message = $message;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the format to send the email in. Either 'html' or 'text'.
+	 *
+	 * @param $format
+	 * @return mixed
+	 */
+	public function format($format)
+	{
+		$this->format = $format;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+	/**
+	 * Resets the state to blank, ready for a new email. Useful when
+	 * sending emails in a loop and you need to make sure that the
+	 * email is reset.
+	 *
+	 * @param bool $clear_attachments
+	 * @return mixed
+	 */
+	public function reset($clear_attachments=true)
+	{
+		$this->to = null;
+		$this->from = null;
+		$this->reply_to = null;
+		$this->cc = null;
+		$this->bcc = null;
+		$this->subject = null;
+		$this->html_message = null;
+		$this->text_message = null;
+		$this->headers = [];
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
 }

myth/Mail/Queue.php

Indentation +3 added lines, -3 removed lines

@@ -34,8 +34,8 @@
 
 class Queue extends CIDbModel {
 
-    protected $table_name = 'mail_queue';
+	protected $table_name = 'mail_queue';
 
-    protected $set_created = false;
-    protected $set_modified = false;
+	protected $set_created = false;
+	protected $set_modified = false;
 }

application/config/auth.php

Indentation +12 added lines, -12 removed lines

@@ -76,7 +76,7 @@ 
 // you might not want the extra risk associated with this cookie-based
 // solution.
 //
-    $config['auth.allow_remembering'] = true;
+	$config['auth.allow_remembering'] = true;
 
 //--------------------------------------------------------------------
 // Remember Me Salt
@@ -86,7 +86,7 @@ 
 // If you are using Remember Me functionality, you should consider
 // changing this value to be unique to your site.
 //
-    $config['auth.salt'] = 'ASimpleSalt';
+	$config['auth.salt'] = 'ASimpleSalt';
 
 //--------------------------------------------------------------------
 // Remember Length
@@ -106,7 +106,7 @@ 
 //      6 months - 14515200
 //      1 year   - 29030400
 //
-    $config['auth.remember_length'] = 1209600;
+	$config['auth.remember_length'] = 1209600;
 
 
 
@@ -123,7 +123,7 @@ 
 // Throttling exponentially increases the time between allowed login
 // attempts.
 //
-    $config['auth.allow_throttling'] = true;
+	$config['auth.allow_throttling'] = true;
 
 //--------------------------------------------------------------------
 // Max Throttling Time
@@ -134,7 +134,7 @@ 
 //
 // This is the number of SECONDS max.
 //
-    $config['auth.max_throttle_time'] = 50;
+	$config['auth.max_throttle_time'] = 50;
 
 //--------------------------------------------------------------------
 // Start Throttling After
@@ -142,7 +142,7 @@ 
 // Throttling will start after X number of attempts. Before this,
 // the user can make attempts like normal.
 //
-    $config['auth.allowed_login_attempts'] = 5;
+	$config['auth.allowed_login_attempts'] = 5;
 
 //--------------------------------------------------------------------
 // Distributed Brute Force Checks
@@ -150,7 +150,7 @@ 
 // The amount to multiply the average daily logins over the last 3 months
 // by to determine if we might be under a distributed brute force attempt.
 //
-    $config['auth.dbrute_multiplier'] = 3;
+	$config['auth.dbrute_multiplier'] = 3;
 
 //--------------------------------------------------------------------
 // Additional Suspension Time for Distributed Brute Force Attempts
@@ -158,7 +158,7 @@ 
 // This is the number of SECONDS that will be added to all login
 // attempts that are being throttled.
 //
-    $config['auth.distributed_brute_add_time'] = 45;
+	$config['auth.distributed_brute_add_time'] = 45;
 
 
 //--------------------------------------------------------------------
@@ -176,7 +176,7 @@ 
 //      - 30 bits of entropy = minimum for a web service with business critical applications (e.g. SAAS).
 //      - 40 bits of entropy = minimum for a bank or other financial service.
 //
-    $config['auth.min_password_strength'] = 18;
+	$config['auth.min_password_strength'] = 18;
 
 //--------------------------------------------------------------------
 // Use Dictionary
@@ -185,7 +185,7 @@ 
 // dictionary to eliminate common words and their variations that would
 // be pretty simply for a hacking attempt to guess?
 //
-    $config['auth.use_dictionary'] = false;
+	$config['auth.use_dictionary'] = false;
 
 //--------------------------------------------------------------------
 // PASSWORD HASHING COST
@@ -208,7 +208,7 @@ 
 //      - 'email'   The are sent an email with an activation link/code
 //      - 'manual'  Requires manual approval by a site administrator.
 //
-    $config['auth.activation_method'] = 'auto';
+	$config['auth.activation_method'] = 'auto';
 
 
 //--------------------------------------------------------------------
@@ -220,4 +220,4 @@ 
 //--------------------------------------------------------------------
 // Sets the Default role id to use when creating new users.
 //
-    $config['auth.default_role_id'] = 3;
+	$config['auth.default_role_id'] = 3;

application/config/events.php

Indentation +7 added lines, -7 removed lines

@@ -51,12 +51,12 @@ 
 // Send New User Registration Email
 Events::on('didRegisterUser', function($data) {
 
-    if ($data['method'] != 'email')
-    {
-        return true;
-    }
+	if ($data['method'] != 'email')
+	{
+		return true;
+	}
 
-    return Mail::deliver('UserMailer:didRegister', [$data]);
+	return Mail::deliver('UserMailer:didRegister', [$data]);
 
 }, EVENTS_PRIORITY_NORMAL);
 
@@ -65,7 +65,7 @@ 
 // Send Forgotten Password email
 Events::on('didRemindUser', function($user, $token) {
 
-    return Mail::deliver('UserMailer:remindUser', [$user, $token]);
+	return Mail::deliver('UserMailer:remindUser', [$user, $token]);
 
 }, EVENTS_PRIORITY_NORMAL);
 
@@ -74,7 +74,7 @@ 
 // Send Reset Password notice
 Events::on('didResetPassword', function($user) {
 
-    return Mail::deliver('UserMailer:resetPassword', [$user]);
+	return Mail::deliver('UserMailer:resetPassword', [$user]);
 
 }, EVENTS_PRIORITY_NORMAL);
 

application/database/migrations/20160111121139_UpdateLoginAttemptsTable.php

Indentation +43 added lines, -43 removed lines

@@ -10,57 +10,57 @@
  */
 class Migration_UpdateLoginAttemmptsTable extends CI_Migration {
 
-    public function up()
-    {
-        $fields = array(
-            'type' => array(
-                'type'       => 'varchar',
-                'constraint' => 64,
-                'null'       => false,
-                'default'    => 'app',
-                'after'      => 'id'
-            ),
-            'ip_address' => array(
-                'type'       => 'varchar',
-                'constraint' => 255,
-                'null'       => true,
-                'after'      => 'type'
-            ),
-            'user_id' => array(
-                'type'       => 'int',
-                'constraint' => 11,
-                'unsigned'   => true,
-                'null'       => true,
-                'after'      => 'ip_address'
-            )
-        );
+	public function up()
+	{
+		$fields = array(
+			'type' => array(
+				'type'       => 'varchar',
+				'constraint' => 64,
+				'null'       => false,
+				'default'    => 'app',
+				'after'      => 'id'
+			),
+			'ip_address' => array(
+				'type'       => 'varchar',
+				'constraint' => 255,
+				'null'       => true,
+				'after'      => 'type'
+			),
+			'user_id' => array(
+				'type'       => 'int',
+				'constraint' => 11,
+				'unsigned'   => true,
+				'null'       => true,
+				'after'      => 'ip_address'
+			)
+		);
 
-        $this->dbforge->add_column('auth_login_attempts', $fields);
+		$this->dbforge->add_column('auth_login_attempts', $fields);
 
-        $this->db->query('ALTER TABLE `auth_login_attempts` ADD KEY (`user_id`)');
+		$this->db->query('ALTER TABLE `auth_login_attempts` ADD KEY (`user_id`)');
 
-        $this->dbforge->drop_column('auth_login_attempts', 'email');
-    }
+		$this->dbforge->drop_column('auth_login_attempts', 'email');
+	}
 
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
 
-    public function down()
-    {
-        $this->dbforge->drop_column('auth_login_attempts', 'type');
-        $this->dbforge->drop_column('auth_login_attempts', 'ip_address');
-        $this->dbforge->drop_column('auth_login_attempts', 'user_id');
+	public function down()
+	{
+		$this->dbforge->drop_column('auth_login_attempts', 'type');
+		$this->dbforge->drop_column('auth_login_attempts', 'ip_address');
+		$this->dbforge->drop_column('auth_login_attempts', 'user_id');
 
-        $column = ['email' => [
-            'type'       => 'varchar',
-            'constraint' => 255,
-            'after'      => 'id'
-        ]];
+		$column = ['email' => [
+			'type'       => 'varchar',
+			'constraint' => 255,
+			'after'      => 'id'
+		]];
 
-        $this->dbforge->add_column('auth_login_attempts', $column);
+		$this->dbforge->add_column('auth_login_attempts', $column);
 
-        $this->db->query('ALTER TABLE `auth_login_attempts` ADD KEY (`email`)');
-    }
+		$this->db->query('ALTER TABLE `auth_login_attempts` ADD KEY (`email`)');
+	}
 
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
 
 }
\ No newline at end of file