salesagility_SuiteCRM/modules/DocumentRevisions/DocumentRevision.php

<?php
if (!defined('sugarEntry') || !sugarEntry) {
    die('Not A Valid Entry Point');
}
/**
 *
 * SugarCRM Community Edition is a customer relationship management program developed by
 * SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
 *
 * SuiteCRM is an extension to SugarCRM Community Edition developed by SalesAgility Ltd.
 * Copyright (C) 2011 - 2018 SalesAgility Ltd.
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by the
 * Free Software Foundation with the addition of the following permission added
 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 *
 * 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 Affero General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Affero General Public License along with
 * this program; if not, see http://www.gnu.org/licenses or write to the Free
 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA.
 *
 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
 * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License version 3.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
 * these Appropriate Legal Notices must retain the display of the "Powered by
 * SugarCRM" logo and "Supercharged by SuiteCRM" logo. If the display of the logos is not
 * reasonably feasible for technical reasons, the Appropriate Legal Notices must
 * display the words "Powered by SugarCRM" and "Supercharged by SuiteCRM".
 */






require_once('include/upload_file.php');

// User is used to store Forecast information.
#[\AllowDynamicProperties]
class DocumentRevision extends SugarBean
{
    public $id;
    public $document_id;
    public $doc_id;
    public $doc_type;
    public $doc_url;
    public $date_entered;
    public $created_by;
    public $filename;
    public $file_mime_type;
    public $revision;
    public $change_log;
    public $document_name;
    public $latest_revision;
    public $file_url;
    public $file_ext;
    public $created_by_name;

    public $img_name;
    public $img_name_bare;

    public $table_name = "document_revisions";
    public $object_name = "DocumentRevision";
    public $module_dir = 'DocumentRevisions';
    public $new_schema = true;
    public $latest_revision_id;

    /*var $column_fields = Array("id"
    	,"document_id"
    	,"date_entered"
    	,"created_by"
    	,"filename"
    	,"file_mime_type"
    	,"revision"
    	,"change_log"
    	,"file_ext"
    	);
*/
    public $encodeFields = array();

    // This is used to retrieve related fields from form posts.
    public $additional_column_fields = array('');

    // This is the list of fields that are in the lists.
    public $list_fields = array("id"
        ,"document_id"
        ,"date_entered"
        ,"created_by"
        ,"filename"
        ,"file_mime_type"
        ,"revision"
        ,"file_url"
        ,"change_log"
        ,"file_ext"
        ,"created_by_name"
        );

    public $required_fields = array("revision");

    public $authenticated = null;


    public function __construct()
    {
        parent::__construct();
        $this->setupCustomFields('DocumentRevisions');  //parameter is module name
        $this->disable_row_level_security =true; //no direct access to this module.
    }




    public function save($check_notify = false)
    {
        $saveRet = parent::save($check_notify);

        //update documents table. (not through save, because it causes a loop)
        // If we don't have a document_id, find it.
        if (empty($this->document_id)) {
            $query = "SELECT document_id FROM document_revisions WHERE id = '".$this->db->quote($this->id)."'";
            $ret = $this->db->query($query, true);
            $row = $this->db->fetchByAssoc($ret);
            $this->document_id = $row['document_id'];
        }
        $query = "UPDATE documents set document_revision_id='".$this->db->quote($this->id)."', doc_type='".$this->db->quote($this->doc_type)."', doc_url='".$this->db->quote($this->doc_url)."', doc_id='".$this->db->quote($this->doc_id)."' where id = '".$this->db->quote($this->document_id)."'";
        $this->db->query($query, true);

        return $saveRet;
    }
    public function get_summary_text()
    {
        return (string)$this->filename;
    }

    public function retrieve($id = -1, $encode=false, $deleted=true)
    {
        $ret = parent::retrieve($id, $encode, $deleted);

        return $ret;
    }

    public function is_authenticated()
    {
        if (!isset($this->authenticated)) {
            LoggerManager::getLogger()->warn('DocumentRevision::$authenticated is not defined');
            return null;
        }
        return $this->authenticated;
    }

    public function fill_in_additional_list_fields()
    {
        $this->fill_in_additional_detail_fields();
    }

    public function fill_in_additional_detail_fields()
    {
        global $theme;
        global $current_language;

        parent::fill_in_additional_detail_fields();

        if (empty($this->id) && empty($this->document_id) && isset($_REQUEST['return_id']) && !empty($_REQUEST['return_id'])) {
            $this->document_id = $_REQUEST['return_id'];
        }

        //find the document name and current version.
        $query = "SELECT document_name, revision, document_revision_id FROM documents, document_revisions where documents.id = '".$this->db->quote($this->document_id)."' AND document_revisions.id = documents.document_revision_id";
        $result = $this->db->query($query, true, "Error fetching document details...:");
        $row = $this->db->fetchByAssoc($result);
        if ($row != null) {
            $this->document_name = $row['document_name'];
            $this->document_name = '<a href="index.php?module=Documents&action=DetailView&record='.$this->document_id.'">'.$row['document_name'].'</a>';
            $this->latest_revision = $row['revision'];
            $this->latest_revision_id = $row['document_revision_id'];

            if (empty($this->revision)) {
                $latestRevision = $this->latest_revision;
                $this->revision = is_numeric($latestRevision) ? $latestRevision + 1 : '';
            }
        }
    }

    /**
     * Returns a filename based off of the logical (Sugar-side) Document name and combined with the revision. Tailor
     * this to needs created by email RFCs, filesystem name conventions, charset conventions etc.
     * @param string revId Revision ID if not latest
     * @return string formatted name
     */
    public function getDocumentRevisionNameForDisplay($revId='')
    {
        global $sugar_config;
        global $current_language;

        $localLabels = return_module_language($current_language, 'DocumentRevisions');

        // prep - get source Document
        $document = BeanFactory::newBean('Documents');

        // use passed revision ID
        if (!empty($revId)) {
            $tempDoc = BeanFactory::newBean('DocumentRevisions');
            $tempDoc->retrieve($revId);
        } else {
            $tempDoc = $this;
        }

        // get logical name
        $document->retrieve($tempDoc->document_id);
        $logicalName = $document->document_name;

        // get revision string
        $revString = '';
        if (!empty($tempDoc->revision)) {
            $revString = "-{$localLabels['LBL_REVISION']}_{$tempDoc->revision}";
        }

        // get extension
        $realFilename = $tempDoc->filename;
        $fileExtension_beg = strrpos((string) $realFilename, ".");
        $fileExtension = "";

        if ($fileExtension_beg > 0) {
            $fileExtension = substr((string) $realFilename, $fileExtension_beg + 1);
        }
        //check to see if this is a file with extension located in "badext"
        foreach ($sugar_config['upload_badext'] as $badExt) {
            if (strtolower($fileExtension) === strtolower($badExt)) {
                //if found, then append with .txt to filename and break out of lookup
                //this will make sure that the file goes out with right extension, but is stored
                //as a text in db.
                $fileExtension .= ".txt";
                break; // no need to look for more
            }
        }
        $fileExtension = ".".$fileExtension;

        $return = $logicalName.$revString.$fileExtension;

        // apply RFC limitations here
        if (mb_strlen($return) > 1024) {
            // do something if we find a real RFC issue
        }

        return $return;
    }

    public function fill_document_name_revision($doc_id)
    {

        //find the document name and current version.
        $query = "SELECT documents.document_name, revision FROM documents, document_revisions where documents.id = '$doc_id'";
        $query .= " AND document_revisions.id = documents.document_revision_id";
        $result = $this->db->query($query, true, "Error fetching document details...:");
        $row = $this->db->fetchByAssoc($result);
        if ($row != null) {
            $this->name = $row['document_name'];
            $this->latest_revision = $row['revision'];
        }
    }

    public function list_view_parse_additional_sections(&$list_form/*, $xTemplateSection*/)
    {
        return $list_form;
    }

    public function get_list_view_data()
    {

        $revision_fields = $this->get_list_view_array();

        $forecast_fields = [];
        $forecast_fields['FILE_URL'] = $this->file_url;

        return $revision_fields;
    }

    //static function..
    public function get_document_revision_name($doc_revision_id)
    {
        if (empty($doc_revision_id)) {
            return null;
        }

        $db = DBManagerFactory::getInstance();
        $query="select revision from document_revisions where id='$doc_revision_id' AND deleted=0";
        $result=$db->query($query);
        if (!empty($result)) {
            $row=$db->fetchByAssoc($result);
            if (!empty($row)) {
                return $row['revision'];
            }
        }
        return null;
    }

    //static function.
    public function get_document_revisions($doc_id)
    {
        $return_array= array();
        if (empty($doc_id)) {
            return $return_array;
        }

        $db = DBManagerFactory::getInstance();
        $query="select id, revision from document_revisions where document_id='$doc_id' and deleted=0";
        $result=$db->query($query);
        if (!empty($result)) {
            while (($row=$db->fetchByAssoc($result)) != null) {
                $return_array[$row['id']]=$row['revision'];
            }
        }
        return $return_array;
    }

    public function bean_implements($interface)
    {
        switch ($interface) {
            case 'FILE': return true;
        }
        return parent::bean_implements($interface);
    }
}

require_once('modules/Documents/DocumentExternalApiDropDown.php');