Current File : /var/www/crm/modules/Documents/Document.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-2012 SugarCRM Inc.
*
* 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. If the display of the logo is not reasonably feasible for
* technical reasons, the Appropriate Legal Notices must display the words
* "Powered by SugarCRM".
********************************************************************************/
require_once ('include/upload_file.php');
// User is used to store Forecast information.
class Document extends SugarBean {
var $id;
var $document_name;
var $description;
var $category_id;
var $subcategory_id;
var $status_id;
var $status;
var $created_by;
var $date_entered;
var $date_modified;
var $modified_user_id;
var $assigned_user_id;
var $active_date;
var $exp_date;
var $document_revision_id;
var $filename;
var $doc_type;
var $img_name;
var $img_name_bare;
var $related_doc_id;
var $related_doc_name;
var $related_doc_rev_id;
var $related_doc_rev_number;
var $is_template;
var $template_type;
//additional fields.
var $revision;
var $last_rev_create_date;
var $last_rev_created_by;
var $last_rev_created_name;
var $file_url;
var $file_url_noimage;
var $table_name = "documents";
var $object_name = "Document";
var $user_preferences;
var $encodeFields = Array ();
// This is used to retrieve related fields from form posts.
var $additional_column_fields = Array ('revision');
var $new_schema = true;
var $module_dir = 'Documents';
var $relationship_fields = Array(
'contract_id'=>'contracts',
);
function Document() {
parent :: SugarBean();
$this->setupCustomFields('Documents'); //parameter is module name
$this->disable_row_level_security = false;
}
function save($check_notify = false) {
if (empty($this->doc_type)) {
$this->doc_type = 'Sugar';
}
if (empty($this->id) || $this->new_with_id)
{
if (empty($this->id)) {
$this->id = create_guid();
$this->new_with_id = true;
}
if ( isset($_REQUEST) && isset($_REQUEST['duplicateSave']) && $_REQUEST['duplicateSave'] == true && isset($_REQUEST['filename_old_doctype']) ) {
$this->doc_type = $_REQUEST['filename_old_doctype'];
$isDuplicate = true;
} else {
$isDuplicate = false;
}
$Revision = new DocumentRevision();
//save revision.
$Revision->in_workflow = true;
$Revision->not_use_rel_in_req = true;
$Revision->new_rel_id = $this->id;
$Revision->new_rel_relname = 'Documents';
$Revision->change_log = translate('DEF_CREATE_LOG','Documents');
$Revision->revision = $this->revision;
$Revision->document_id = $this->id;
$Revision->filename = $this->filename;
if(isset($this->file_ext))
{
$Revision->file_ext = $this->file_ext;
}
if(isset($this->file_mime_type))
{
$Revision->file_mime_type = $this->file_mime_type;
}
$Revision->doc_type = $this->doc_type;
if ( isset($this->doc_id) ) {
$Revision->doc_id = $this->doc_id;
}
if ( isset($this->doc_url) ) {
$Revision->doc_url = $this->doc_url;
}
$Revision->id = create_guid();
$Revision->new_with_id = true;
$createRevision = false;
//Move file saved during populatefrompost to match the revision id rather than document id
if (!empty($_FILES['filename_file'])) {
rename("upload://{$this->id}", "upload://{$Revision->id}");
$createRevision = true;
} else if ( $isDuplicate && ( empty($this->doc_type) || $this->doc_type == 'Sugar' ) ) {
// Looks like we need to duplicate a file, this is tricky
$oldDocument = new Document();
$oldDocument->retrieve($_REQUEST['duplicateId']);
$old_name = "upload://{$oldDocument->document_revision_id}";
$new_name = "upload://{$Revision->id}";
$GLOBALS['log']->debug("Attempting to copy from $old_name to $new_name");
copy($old_name, $new_name);
$createRevision = true;
}
// For external documents, we just need to make sure we have a doc_id
if ( !empty($this->doc_id) && $this->doc_type != 'Sugar' ) {
$createRevision = true;
}
if ( $createRevision ) {
$Revision->save();
//update document with latest revision id
$this->process_save_dates=false; //make sure that conversion does not happen again.
$this->document_revision_id = $Revision->id;
}
//set relationship field values if contract_id is passed (via subpanel create)
if (!empty($_POST['contract_id'])) {
$save_revision['document_revision_id']=$this->document_revision_id;
$this->load_relationship('contracts');
$this->contracts->add($_POST['contract_id'],$save_revision);
}
if ((isset($_POST['load_signed_id']) and !empty($_POST['load_signed_id']))) {
$query="update linked_documents set deleted=1 where id='".$_POST['load_signed_id']."'";
$this->db->query($query);
}
}
return parent :: save($check_notify);
}
function get_summary_text() {
return "$this->document_name";
}
function is_authenticated() {
return $this->authenticated;
}
function fill_in_additional_list_fields() {
$this->fill_in_additional_detail_fields();
}
function fill_in_additional_detail_fields() {
global $theme;
global $current_language;
global $timedate;
global $locale;
parent::fill_in_additional_detail_fields();
$mod_strings = return_module_language($current_language, 'Documents');
if (!empty($this->document_revision_id)) {
$query = "SELECT users.first_name AS first_name, users.last_name AS last_name, document_revisions.date_entered AS rev_date,
document_revisions.filename AS filename, document_revisions.revision AS revision,
document_revisions.file_ext AS file_ext, document_revisions.file_mime_type AS file_mime_type
FROM users, document_revisions
WHERE users.id = document_revisions.created_by AND document_revisions.id = '$this->document_revision_id'";
$result = $this->db->query($query);
$row = $this->db->fetchByAssoc($result);
//populate name
if(isset($this->document_name))
{
$this->name = $this->document_name;
}
if(isset($row['filename']))$this->filename = $row['filename'];
//$this->latest_revision = $row['revision'];
if(isset($row['revision']))$this->revision = $row['revision'];
//image is selected based on the extension name <ext>_icon_inline, extension is stored in document_revisions.
//if file is not found then default image file will be used.
global $img_name;
global $img_name_bare;
if (!empty ($row['file_ext'])) {
$img_name = SugarThemeRegistry::current()->getImageURL(strtolower($row['file_ext'])."_image_inline.gif");
$img_name_bare = strtolower($row['file_ext'])."_image_inline";
}
}
//set default file name.
if (!empty ($img_name) && file_exists($img_name)) {
$img_name = $img_name_bare;
} else {
$img_name = "def_image_inline"; //todo change the default image.
}
if($this->ACLAccess('DetailView')) {
if(!empty($this->doc_type) && $this->doc_type != 'Sugar' && !empty($this->doc_url)) {
$file_url= "<a href='".$this->doc_url."' target='_blank'>".SugarThemeRegistry::current()->getImage($this->doc_type.'_image_inline', 'border="0"',null,null,'.png',$mod_strings['LBL_LIST_VIEW_DOCUMENT'])."</a>";
} else {
$file_url = "<a href='index.php?entryPoint=download&id={$this->document_revision_id}&type=Documents' target='_blank'>".SugarThemeRegistry::current()->getImage($img_name, 'border="0"', null,null,'.gif',$mod_strings['LBL_LIST_VIEW_DOCUMENT'])."</a>";
}
$this->file_url = $file_url;
$this->file_url_noimage = "index.php?entryPoint=download&type=Documents&id={$this->document_revision_id}";
}else{
$this->file_url = "";
$this->file_url_noimage = "";
}
//get last_rev_by user name.
if (!empty ($row)) {
$this->last_rev_created_name = $locale->getLocaleFormattedName($row['first_name'], $row['last_name']);
$this->last_rev_create_date = $timedate->to_display_date_time($this->db->fromConvert($row['rev_date'], 'datetime'));
$this->last_rev_mime_type = $row['file_mime_type'];
}
global $app_list_strings;
if(!empty($this->status_id)) {
//_pp($this->status_id);
$this->status = $app_list_strings['document_status_dom'][$this->status_id];
}
if (!empty($this->related_doc_id)) {
$this->related_doc_name = Document::get_document_name($this->related_doc_id);
$this->related_doc_rev_number = DocumentRevision::get_document_revision_name($this->related_doc_rev_id);
}
}
function list_view_parse_additional_sections(& $list_form, $xTemplateSection) {
return $list_form;
}
function create_export_query(&$order_by, &$where, $relate_link_join='')
{
$custom_join = $this->custom_fields->getJOIN(true, true,$where);
if($custom_join)
$custom_join['join'] .= $relate_link_join;
$query = "SELECT
documents.*";
if($custom_join){
$query .= $custom_join['select'];
}
$query .= " FROM documents ";
if($custom_join){
$query .= $custom_join['join'];
}
$where_auto = " documents.deleted = 0";
if ($where != "")
$query .= " WHERE $where AND ".$where_auto;
else
$query .= " WHERE ".$where_auto;
if ($order_by != "")
$query .= " ORDER BY $order_by";
else
$query .= " ORDER BY documents.document_name";
return $query;
}
function get_list_view_data() {
global $current_language;
$app_list_strings = return_app_list_strings_language($current_language);
$document_fields = $this->get_list_view_array();
$this->fill_in_additional_list_fields();
$document_fields['FILENAME'] = $this->filename;
$document_fields['FILE_URL'] = $this->file_url;
$document_fields['FILE_URL_NOIMAGE'] = $this->file_url_noimage;
$document_fields['LAST_REV_CREATED_BY'] = $this->last_rev_created_name;
$document_fields['CATEGORY_ID'] = empty ($this->category_id) ? "" : $app_list_strings['document_category_dom'][$this->category_id];
$document_fields['SUBCATEGORY_ID'] = empty ($this->subcategory_id) ? "" : $app_list_strings['document_subcategory_dom'][$this->subcategory_id];
$document_fields['NAME'] = $this->document_name;
$document_fields['DOCUMENT_NAME_JAVASCRIPT'] = $GLOBALS['db']->quote($document_fields['DOCUMENT_NAME']);
return $document_fields;
}
/**
* mark_relationships_deleted
*
* Override method from SugarBean to handle deleting relationships associated with a Document. This method will
* remove DocumentRevision relationships and then optionally delete Contracts depending on the version.
*
* @param $id String The record id of the Document instance
*/
function mark_relationships_deleted($id)
{
$this->load_relationships('revisions');
$revisions= $this->get_linked_beans('revisions','DocumentRevision');
if (!empty($revisions) && is_array($revisions)) {
foreach($revisions as $key=>$version) {
UploadFile::unlink_file($version->id,$version->filename);
//mark the version deleted.
$version->mark_deleted($version->id);
}
}
}
function bean_implements($interface) {
switch ($interface) {
case 'ACL' :
return true;
}
return false;
}
//static function.
function get_document_name($doc_id){
if (empty($doc_id)) return null;
$db = DBManagerFactory::getInstance();
$query="select document_name from documents where id='$doc_id'";
$result=$db->query($query);
if (!empty($result)) {
$row=$db->fetchByAssoc($result);
if (!empty($row)) {
return $row['document_name'];
}
}
return null;
}
}
require_once('modules/Documents/DocumentExternalApiDropDown.php');
Mini Shell