dolibarr 25.0.0-alpha
myobject_document.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2007-2017 Laurent Destailleur <eldy@users.sourceforge.net>
3 * Copyright (C) 2024 Frédéric France <frederic.france@free.fr>
4 * Copyright (C) ---Replace with your own copyright and developer email---
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <https://www.gnu.org/licenses/>.
18 */
19
26// General defined Options
27//if (! defined('CSRFCHECK_WITH_TOKEN')) define('CSRFCHECK_WITH_TOKEN', '1'); // Force use of CSRF protection with tokens even for GET
28//if (! defined('MAIN_AUTHENTICATION_MODE')) define('MAIN_AUTHENTICATION_MODE', 'aloginmodule'); // Force authentication handler
29//if (! defined('MAIN_LANG_DEFAULT')) define('MAIN_LANG_DEFAULT', 'auto'); // Force LANG (language) to a particular value
30//if (! defined('MAIN_SECURITY_FORCECSP')) define('MAIN_SECURITY_FORCECSP', 'none'); // Disable all Content Security Policies
31//if (! defined('NOBROWSERNOTIF')) define('NOBROWSERNOTIF', '1'); // Disable browser notification
32//if (! defined('NOIPCHECK')) define('NOIPCHECK', '1'); // Do not check IP defined into conf $dolibarr_main_restrict_ip
33//if (! defined('NOLOGIN')) define('NOLOGIN', '1'); // Do not use login - if this page is public (can be called outside logged session). This includes the NOIPCHECK too.
34//if (! defined('NOREQUIREAJAX')) define('NOREQUIREAJAX', '1'); // Do not load ajax.lib.php library
35//if (! defined('NOREQUIREDB')) define('NOREQUIREDB', '1'); // Do not create database handler $db
36//if (! defined('NOREQUIREHTML')) define('NOREQUIREHTML', '1'); // Do not load html.form.class.php
37//if (! defined('NOREQUIREMENU')) define('NOREQUIREMENU', '1'); // Do not load and show top and left menu
38//if (! defined('NOREQUIRESOC')) define('NOREQUIRESOC', '1'); // Do not load object $mysoc
39//if (! defined('NOREQUIRETRAN')) define('NOREQUIRETRAN', '1'); // Do not load object $langs
40//if (! defined('NOREQUIREUSER')) define('NOREQUIREUSER', '1'); // Do not load object $user
41//if (! defined('NOSCANGETFORINJECTION')) define('NOSCANGETFORINJECTION', '1'); // Do not check injection attack on GET parameters
42//if (! defined('NOSCANPOSTFORINJECTION')) define('NOSCANPOSTFORINJECTION', '1'); // Do not check injection attack on POST parameters
43//if (! defined('NOSTYLECHECK')) define('NOSTYLECHECK', '1'); // Do not check style html tag into posted data
44//if (! defined('NOTOKENRENEWAL')) define('NOTOKENRENEWAL', '1'); // Do not roll the Anti CSRF token (used if MAIN_SECURITY_CSRF_WITH_TOKEN is on)
45
46
47// Load Dolibarr environment
48$res = 0;
49// Try main.inc.php into web root known defined into CONTEXT_DOCUMENT_ROOT (not always defined)
50if (!$res && !empty($_SERVER["CONTEXT_DOCUMENT_ROOT"])) {
51 $res = @include str_replace("..", "", $_SERVER["CONTEXT_DOCUMENT_ROOT"])."/main.inc.php";
52}
53// Try main.inc.php into web root detected using web root calculated from SCRIPT_FILENAME
54$tmp = empty($_SERVER['SCRIPT_FILENAME']) ? '' : $_SERVER['SCRIPT_FILENAME'];
55$tmp2 = realpath(__FILE__);
56$i = strlen($tmp) - 1; // @phan-suppress-current-line DolibarrForbiddenFunctionPlugin
57$j = strlen($tmp2) - 1; // @phan-suppress-current-line DolibarrForbiddenFunctionPlugin
58while ($i > 0 && $j > 0 && isset($tmp[$i]) && isset($tmp2[$j]) && $tmp[$i] == $tmp2[$j]) {
59 $i--;
60 $j--;
61}
62if (!$res && $i > 0 && file_exists(substr($tmp, 0, ($i + 1))."/main.inc.php")) {
63 $res = @include substr($tmp, 0, ($i + 1))."/main.inc.php";
64}
65if (!$res && $i > 0 && file_exists(dirname(substr($tmp, 0, ($i + 1)))."/main.inc.php")) {
66 $res = @include dirname(substr($tmp, 0, ($i + 1)))."/main.inc.php";
67}
68// Try main.inc.php using relative path
69if (!$res && file_exists("../main.inc.php")) {
70 $res = @include "../main.inc.php";
71}
72if (!$res && file_exists("../../main.inc.php")) {
73 $res = @include "../../main.inc.php";
74}
75if (!$res && file_exists("../../../main.inc.php")) {
76 $res = @include "../../../main.inc.php";
77}
78if (!$res) {
79 die("Include of main fails");
80}
89include_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
90include_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
91require_once DOL_DOCUMENT_ROOT . '/core/lib/functions.lib.php';
92include_once DOL_DOCUMENT_ROOT.'/core/lib/images.lib.php';
93include_once DOL_DOCUMENT_ROOT.'/core/class/html.formfile.class.php';
94dol_include_once('/mymodule/class/myobject.class.php');
95dol_include_once('/mymodule/lib/mymodule_myobject.lib.php');
96
97// Load translation files required by the page
98$langs->loadLangs(array("mymodule@mymodule", "companies", "other", "mails"));
99
100// Get parameters
101$action = GETPOST('action', 'aZ09');
102$confirm = GETPOST('confirm');
103$id = (GETPOSTINT('socid') ? GETPOSTINT('socid') : GETPOSTINT('id'));
104$ref = GETPOST('ref', 'alpha');
105
106$limit = GETPOSTINT('limit') ? GETPOSTINT('limit') : $conf->liste_limit;
107$sortfield = GETPOST('sortfield', 'aZ09comma');
108$sortorder = GETPOST('sortorder', 'aZ09comma');
109$page = GETPOSTISSET('pageplusone') ? (GETPOSTINT('pageplusone') - 1) : GETPOSTINT("page");
110if (empty($page) || $page == -1) {
111 $page = 0;
112} // If $page is not defined, or '' or -1
113$offset = $limit * $page;
114$pageprev = $page - 1;
115$pagenext = $page + 1;
116if (!$sortorder) {
117 $sortorder = "ASC";
118}
119if (!$sortfield) {
120 $sortfield = "name";
121}
122//if (! $sortfield) $sortfield="position_name";
123
124// Initialize a technical objects
125$object = new MyObject($db);
126$extrafields = new ExtraFields($db);
127$diroutputmassaction = $conf->mymodule->dir_output.'/temp/massgeneration/'.$user->id;
128$hookmanager->initHooks(array($object->element.'document', 'globalcard')); // Note that conf->hooks_modules contains array
129
130// Fetch optionals attributes and labels
131$extrafields->fetch_name_optionals_label($object->table_element);
132
133// Load object
134include DOL_DOCUMENT_ROOT.'/core/actions_fetchobject.inc.php'; // Must be 'include', not 'include_once'. Include fetch and fetch_thirdparty but not fetch_optionals
135
136$upload_dir = null;
137if ($id > 0 || !empty($ref)) {
138 $upload_dir = $conf->mymodule->multidir_output[$object->entity ? $object->entity : $conf->entity]."/myobject/".get_exdir(0, 0, 0, 1, $object);
139}
140
141// Permissions
142// (There are several ways to check permission.)
143// Set $enablepermissioncheck to 1 to enable a minimum low level of checks
144$enablepermissioncheck = getDolGlobalInt('MYMODULE_ENABLE_PERMISSION_CHECK');
145if ($enablepermissioncheck) {
146 $permissiontoread = $user->hasRight('mymodule', 'myobject', 'read');
147 $permissiontoadd = $user->hasRight('mymodule', 'myobject', 'write'); // Used by the include of actions_addupdatedelete.inc.php and actions_linkedfiles.inc.php
148} else {
149 $permissiontoread = 1;
150 $permissiontoadd = 1;
151}
152
153// Security check (enable the most restrictive one)
154//if ($user->socid > 0) accessforbidden();
155//if ($user->socid > 0) $socid = $user->socid;
156//$isdraft = (($object->status == $object::STATUS_DRAFT) ? 1 : 0);
157//restrictedArea($user, $object->module, $object->id, $object->table_element, $object->element, 'fk_soc', 'rowid', $isdraft);
158if (!isModEnabled("mymodule")) {
160}
161if (!$permissiontoread) {
163}
164if (empty($object->id) || $upload_dir === null) {
166}
167
168
169
170/*
171 * Actions
172 */
173
174include DOL_DOCUMENT_ROOT.'/core/actions_linkedfiles.inc.php';
175
176
177/*
178 * View
179 */
180
181$form = new Form($db);
182
183// Header
184// ------
185$title = $langs->trans("MyObject")." - ".$langs->trans("Files");
186//$title = $object->ref." - ".$langs->trans("Files");
187$help_url = '';
188//Example $help_url='EN:Module_Third_Parties|FR:Module_Tiers|ES:Empresas';
189llxHeader('', $title, $help_url, '', 0, 0, '', '', '', 'mod-mymodule page-card_document');
190
191// Show tabs
192$head = myobjectPrepareHead($object);
193
194print dol_get_fiche_head($head, 'document', $langs->trans("MyObject"), -1, $object->picto, 0, '', '', 0, '', 1);
195
196
197// Build file list
198$filearray = dol_dir_list($upload_dir, "files", 0, '', '(\.meta|_preview.*\.png)$', $sortfield, (dol_strtolower($sortorder) == 'desc' ? SORT_DESC : SORT_ASC), 1);
199$totalsize = 0;
200foreach ($filearray as $key => $file) {
201 $totalsize += $file['size'];
202}
203
204// Object card
205// ------------------------------------------------------------
206$linkback = '<a href="'.dol_buildpath('/mymodule/myobject_list.php', 1).'?restore_lastsearch_values=1'.(!empty($socid) ? '&socid='.$socid : '').'">'.$langs->trans("BackToList").'</a>';
207
208$morehtmlref = '<div class="refidno">';
209/*
210// Ref customer
211$morehtmlref.=$form->editfieldkey("RefCustomer", 'ref_client', $object->ref_client, $object, 0, 'string', '', 0, 1);
212$morehtmlref.=$form->editfieldval("RefCustomer", 'ref_client', $object->ref_client, $object, 0, 'string', '', null, null, '', 1);
213// Thirdparty
214$morehtmlref.='<br>'.$langs->trans('ThirdParty') . ' : ' . (is_object($object->thirdparty) ? $object->thirdparty->getNomUrl(1) : '');
215// Project
216if (isModEnabled('project')) {
217 // Project
218 if (isModEnabled('project')) {
219 $langs->load("projects");
220 if (!empty($object->fk_project)) {
221 $proj = new Project($db);
222 $proj->fetch($object->fk_project);
223 $morehtmlref .= $proj->getNomUrl(1);
224 if ($proj->title) {
225 $morehtmlref .= '<span class="opacitymedium"> - '.dol_escape_htmltag($proj->title).'</span>';
226 }
227 }
228 }
229 }
230*/
231$morehtmlref .= '</div>';
232
233dol_banner_tab($object, 'ref', $linkback, 1, 'ref', 'ref', $morehtmlref);
234
235print '<div class="fichecenter">';
236
237print '<div class="underbanner clearboth"></div>';
238print '<table class="border centpercent tableforfield">';
239
240// Number of files
241print '<tr><td class="titlefield">'.$langs->trans("NbOfAttachedFiles").'</td><td colspan="3">'.count($filearray).'</td></tr>';
242
243// Total size
244print '<tr><td>'.$langs->trans("TotalSizeOfAttachedFiles").'</td><td colspan="3">'.$totalsize.' '.$langs->trans("bytes").'</td></tr>';
245
246print '</table>';
247
248print '</div>';
249
250print dol_get_fiche_end();
251
252//$modulepart = 'mymodule';
253$modulepart = 'myobject@mymodule';
254$param = '&id='.$object->id;
255//$relativepathwithnofile='myobject/' . dol_sanitizeFileName($object->id).'/';
256//$relativepathwithnofile = 'myobject/'.dol_sanitizeFileName($object->ref).'/';
257$relativepathwithnofile = dol_sanitizeFileName($object->ref).'/';
258
259include DOL_DOCUMENT_ROOT.'/core/tpl/document_actions_post_headers.tpl.php';
260
261// End of page
262llxFooter();
263$db->close();
$id
Support class for third parties, contacts, members, users or resources.
Definition account.php:47
if(! $sortfield) if(! $sortorder) $object
Definition account.php:100
llxFooter($comment='', $zone='private', $disabledoutputofmessages=0)
Empty footer.
Definition wrapper.php:91
if(!defined('NOREQUIRESOC')) if(!defined( 'NOREQUIRETRAN')) if(!defined('NOTOKENRENEWAL')) if(!defined( 'NOREQUIREMENU')) if(!defined('NOREQUIREHTML')) if(!defined( 'NOREQUIREAJAX')) llxHeader($head='', $title='', $help_url='', $target='', $disablejs=0, $disablehead=0, $arrayofjs='', $arrayofcss='', $morequerystring='', $morecssonbody='', $replacemainareaby='', $disablenofollow=0, $disablenoindex=0)
Empty header.
Definition wrapper.php:73
Class to manage standard extra fields.
Class to manage generation of HTML components Only common components must be here.
Class for MyObject.
if(!isModEnabled('ai')||!getDolGlobalString('AI_ASSISTANT_ENABLED')) global $conf
The main.inc.php has been included so the following variable are now defined:
dol_dir_list($utf8_path, $types="all", $recursive=0, $filter="", $excludefilter=null, $sortcriteria="name", $sortorder=SORT_ASC, $mode=0, $nohook=0, $relativename="", $donotfollowsymlinks=0, $nbsecondsold=0)
Scan a directory and return a list of files/directories.
Definition files.lib.php:65
dol_strtolower($string, $encoding="UTF-8")
Convert a string to lower.
dol_sanitizeFileName($str, $newstr='_', $unaccent=1, $includequotes=0, $allowdash=0)
Clean a string to use it as a file name.
getDolGlobalInt($key, $default=0)
Return a Dolibarr global constant int value.
if(!function_exists( 'dol_getprefix')) dol_include_once($relpath, $classname='')
Make an include_once using default root and alternate root if it fails.
GETPOST($paramname, $check='alphanohtml', $method=0, $filter=null, $options=null, $noreplace=0, $nodefault=0)
Return value of a param into GET or POST supervariable.
GETPOSTINT($paramname, $method=0, $nodefault=0)
Return the value of a $_GET or $_POST supervariable, converted into integer.
GETPOSTISSET($paramname)
Return true if we are in a context of submitting the parameter $paramname from a POST of a form.
isModEnabled($module)
Is Dolibarr module enabled.
get_exdir($num, $level, $alpha, $withoutslash, $object, $modulepart='')
Return a path to have a the directory according to object where files are stored.
dol_get_fiche_head($links=array(), $active='', $title='', $notab=0, $picto='', $pictoisfullpath=0, $morehtmlright='', $morecss='', $limittoshow=0, $moretabssuffix='', $dragdropfile=0, $morecssdiv='')
Show tabs of a record.
Definition html.lib.php:540
dol_get_fiche_end($notab=0)
Return tab footer of a card.
Definition html.lib.php:738
myobjectPrepareHead($object)
Prepare array of tabs for MyObject.
accessforbidden($message='', $printheader=1, $printfooter=1, $showonlymessage=0, $params=null)
Show a message to say access is forbidden and stop program.