<?php
#BEGIN_LICENSE
#-------------------------------------------------------------------------
# Module: CMSMSExt (c) 2020-2021 by CMS Made Simple Foundation
#  An add-on module for CMS Made Simple to provide useful functions
#  and commonly used gui capabilities to other modules.
#-------------------------------------------------------------------------
# A fork of:
#
# Module: CGExtensions (c) 2008-2014 by Robert Campbell
#         (calguy1000@cmsmadesimple.org)
#
#-------------------------------------------------------------------------
#
# CMSMS - CMS Made Simple is (c) 2006 - 2021 by CMS Made Simple Foundation
# CMSMS - CMS Made Simple is (c) 2005 by Ted Kulp (wishy@cmsmadesimple.org)
# Visit the CMSMS Homepage at: http://www.cmsmadesimple.org
#
#-------------------------------------------------------------------------
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# However, as a special exception to the GPL, this software is distributed
# as an addon module to CMS Made Simple.  You may not use this software
# in any Non GPL version of CMS Made simple, or in any version of CMS
# Made simple that does not indicate clearly and obviously in its admin
# section that the site was built with CMS Made simple.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
# Or read it online: http://www.gnu.org/licenses/licenses.html#GPL
#
#-------------------------------------------------------------------------
#END_LICENSE

/**
 * Defines an object for loading and saving email objects from file.
 *
 * @package CMSMSExt\Email
 * @category Utilities
 * @author  calguy1000 <calguy1000@cmsmadesimple.org>
 * @copyright Copyright 2018 by Robert Campbell
 */

namespace CMSMSExt\Email;

/**
 * This class can load and save email objects to the filesystem in a specialized format.
 * It will also search in the module directory, and in the /asssets/emails directory for emails.
 *
 * @package CMSMSExt\Email
 * @category Utilities
 * @author  calguy1000 <calguy1000@cmsmadesimple.org>
 * @copyright Copyright 2018 by Robert Campbell
 */
class FileEmailStorage implements iEmailStorage
{
    /**
     * @ignore
     */
    private $_mod;

    /**
     * Constructor
     *
     * @param \CMSMSExt\XTModule $mod A reference to a module derived from XTModule.
     */
    public function __construct(\CMSMSExt\XTModule $mod)
    {
        $this->_mod = $mod;
    }

    /**
     * Load an email object from a file.
     *
     * This method will look for a file with the specified name, ending with '.eml' in the following directories:
     *   assets/module_custom/<ModuleName>/emails,  assets/emails,  and modules/<ModuleName>/emails
     *
     * It is expected that the file if exists, is a formatted text file with three sections:
     *
     * top section (ini format)
     * ==== ====
     * smarty template for email subject
     * ==== ====
     * smarty template for email body
     *
     * @example sending_an_email.php
     * @param string $name the object name
     * @return Email|null
     */
    public function load( string $name )
    {
        $orig_name = $name = trim( $name );
        if( !$name ) throw new \InvalidArgumentException( 'Invalid name passed to '.__METHOD__);
        if( !endswith( $name, '.eml' ) ) $name .= '.eml';

        //$config = \cms_utils::get_config();
        $config = \CMSMSExt\config::GetInstance();
        
        $dirs = [
            $config['assets_path'].'/module_custom/'.$this->_mod->GetName().'/emails',
            $config['assets_path'].'/emails',
            $this->_mod->GetModulePath().'/emails'
            ];
        $filename = null;
        foreach( $dirs as $dir ) {
            $fn = $dir."/$name";
            if( is_file( $fn ) ) {
                $filename = $fn;
                break;
            }
        }
        if( !$filename ) return;

        // file is divided into 3 sections separated by a line beginning and ending with at lesast 4 = characters.
        $part = 0;
        $ini = $subj = $body = null;
        $fh = fopen( $filename, 'r' );
        while( !feof( $fh ) ) {
            $line = fgets( $fh );
            $line = trim($line);
            if( startswith( $line, '====') && endswith( $line, '====') ) {
                // new part.
                $part++;
                continue;
            }
            switch( $part ) {
            case 0: // ini
                $ini .= $line."\n";
                break;
            case 1: // subject template
                $subj .= $line."\n";
                break;
            case 2: // body template
                $body .= $line."\n";
                break;
            }
        }

        if( !$ini ) throw new \RuntimeException('Invalid eml file data: No INI Section');
        $body = trim($body);
        $subj = trim($subj);
        if( $subj && !$body ) $body = $subj; // no subject supplied
        if( !$body ) throw new \RuntimeException('Invalid eml file data: No valid body section');

        $data = parse_ini_string( $ini );
        if( !$data || !is_array($data) || !count($data) ) throw new \RuntimeException('Invalid eml file data: invalid IMI secion');
        $data['name'] = $orig_name;

        if( $subj ) $data['subj_tpl'] = $subj;
        $data['body_tpl'] = $body;
        $email = Email::from_array( $data );
        return $email;
    }

    /**
     * Save an email object to a file.
     *
     * Will ONLY save email files to the /assets/emails directory.
     *
     * @param Email $eml The object to save.
     */
    public function save( Email $eml )
    {
        die('incomplete at '.__FILE__.'::'.__LINE__);
    }
} // class