modFTP.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2003      Rodolphe Quiedeville <rodolphe@quiedeville.org>
 * Copyright (C) 2004-2008 Laurent Destailleur  <eldy@users.sourceforge.net>
 * Copyright (C) 2026       Frédéric France         <frederic.france@free.fr>
 *
 * 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 3 of the License, or
 * (at your option) any later version.
 *
 * 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, see <https://www.gnu.org/licenses/>.
 */
 
include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
 
 
class modFTP extends DolibarrModules
{
  public function __construct($db)
  {
    $this->db = $db;
 
    // Id for module (must be unique).
    // Use here a free id.
    $this->numero = 2800;
 
    // Family can be 'crm','financial','hr','projects','product','ecm','technic','other'
    // It is used to sort modules in module setup page
    $this->family = "interface";
    // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
    $this->name = preg_replace('/^mod/i', '', get_class($this));
    // Module description used if translation string 'ModuleXXXDesc' not found (XXX is id value)
    $this->description = "FTP Client";
    // Possible values for version are: 'development', 'experimental', 'dolibarr' or version
    $this->version = 'dolibarr_deprecated';
    // Key used in llx_const table to save module status enabled/disabled (XXX is id value)
    $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
    // Name of png file (without png) used for this module
    $this->picto = 'folder';
 
    // Data directories to create when module is enabled
    $this->dirs = array("/ftp/temp");
 
    // Langs file within the module
    $this->langfiles = array("ftp");
 
    // Config pages. Put here list of php page names stored in admmin directory used to setup module
    $this->config_page_url = array('ftpclient.php@ftp');
 
    // Dependencies
    $this->depends = array(); // List of modules id that must be enabled if this module is enabled
    $this->requiredby = array(); // List of modules id to disable if this one is disabled
 
    // Constants
    $this->const = [
      ['FTP_CONNECT_WITH_SSL', 'chaine', '0', 'Use FTPS for FTP module', 1, 'current', 1],
      ['FTP_CONNECT_WITH_SFTP', 'chaine', '0', 'Use SFTP for FTP module', 1, 'current', 1],
    ]; // List of parameters
 
    // Boxes
    $this->boxes = []; // List of boxes
    $r = 0;
 
    // Add here list of php file(s) stored in core/boxes that contains class to show a box.
    // Example:
    //$this->boxes[$r][1] = "myboxa.php";
    //$r++;
    //$this->boxes[$r][1] = "myboxb.php";
    //$r++;
 
    // Permissions
    $this->rights_class = 'ftp'; // Permission key
    $this->rights = array(); // Permission array used by this module
 
    $r++;
    $this->rights[$r][0] = 2801;
    $this->rights[$r][1] = 'Use FTP client in read mode (browse and download only)';
    $this->rights[$r][2] = 'r';
    $this->rights[$r][3] = 0;
    $this->rights[$r][4] = 'read';
 
    $r++;
    $this->rights[$r][0] = 2802;
    $this->rights[$r][1] = 'Use FTP client in write mode (delete or upload files)';
    $this->rights[$r][2] = 'w';
    $this->rights[$r][3] = 0;
    $this->rights[$r][4] = 'write';
 
 
    // Menus
    //-------
    $this->menu[$r] = array('fk_menu'=>0,
                'type'=>'top',
                'titre'=>'FTP',
                'prefix' => img_picto('', $this->picto, 'class="pictofixedwidth em092"'),
                'mainmenu'=>'ftp',
                'url'=>'/ftp/index.php',
                'langs'=>'ftp',
                'position'=>100,
                'enabled'=>'isModEnabled("ftp")',
                'perms'=>'$user->hasRight("ftp", "read") || $user->hasRight("ftp", "write") || $user->hasRight("ftp", "setup")',
                'target'=>'',
                'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
    $r++;
  }
}