Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5
Source code for file /joomla/client/helper.php

Documentation is available at helper.php

  1. <?php
  2. /**
  3.  * @version        $Id: helper.php 6474 2007-02-03 21:01:56Z friesengeist $
  4.  * @package        Joomla.Framework
  5.  * @subpackage    Client
  6.  * @copyright    Copyright (C) 2005 - 2007 Open Source Matters. All rights reserved.
  7.  * @license        GNU/GPL, see LICENSE.php
  8.  *  Joomla! is free software and parts of it may contain or be derived from the
  9.  *  GNU General Public License or other free or open source software licenses.
  10.  *  See COPYRIGHT.php for copyright notices and details.
  11.  */
  12.  
  13. /**
  14.  * Client helper class
  15.  *
  16.  * @static
  17.  * @author        Louis Landry <[email protected]>
  18.  * @author        Enno Klasing <[email protected]>
  19.  * @package        Joomla.Framework
  20.  * @subpackage    Client
  21.  * @since        1.5
  22.  */
  23. class JClientHelper
  24. {
  25.     /**
  26.      * Method to return the array of client layer configuration options
  27.      *
  28.      * @static
  29.      * @param    string    Client name, currently only 'ftp' is supported
  30.      * @param    boolean    Forces re-creation of the login credentials. Set this to
  31.      *                     true if login credentials in the session storage have changed
  32.      * @return    array    Client layer configuration options, consisting of at least
  33.      *                     these fields: enabled, host, port, user, pass, root
  34.      * @since    1.5
  35.      */
  36.     function getCredentials($client, $force=false)
  37.     {
  38.         static $credentials = array();
  39.  
  40.         $client = strtolower($client);
  41.  
  42.         if (!isset($credentials[$client]) || $force)
  43.         {
  44.             // Initialize variables
  45.                         $config =& JFactory::getConfig();
  46.  
  47.             // Fetch the client layer configuration options for the specific client
  48.                         switch ($client)
  49.             {
  50.                 case 'ftp':
  51.                     $options = array(
  52.                         'enabled'    => $config->getValue('config.ftp_enable'),
  53.                         'host'        => $config->getValue('config.ftp_host'),
  54.                         'port'        => $config->getValue('config.ftp_port'),
  55.                         'user'        => $config->getValue('config.ftp_user'),
  56.                         'pass'        => $config->getValue('config.ftp_pass'),
  57.                         'root'        => $config->getValue('config.ftp_root')
  58.                     );
  59.                     break;
  60.  
  61.                 default:
  62.                     $options = array(
  63.                         'enabled'    => false,
  64.                         'host'        => '',
  65.                         'port'        => '',
  66.                         'user'        => '',
  67.                         'pass'        => '',
  68.                         'root'        => ''
  69.                     );
  70.                     break;
  71.             }
  72.  
  73.             // If user and pass are not set in global config lets see if its in the session
  74.                         if ($options['enabled'] == true && ($options['user'] == '' || $options['pass'] == ''))
  75.             {
  76.                 $session =& JFactory::getSession();
  77.                 $options['user'] = $session->get($client.'.user', null, 'JClientHelper');
  78.                 $options['pass'] = $session->get($client.'.pass', null, 'JClientHelper');
  79.             }
  80.  
  81.             // If user or pass are missing, disable this client
  82.                         if ($options['user'] == '' || $options['pass'] == '') {
  83.                 $options['enabled'] = false;
  84.             }
  85.  
  86.             // Save the credentials for later use
  87.                         $credentials[$client] = $options;
  88.         }
  89.  
  90.         return $credentials[$client];
  91.     }
  92.  
  93.     /**
  94.      * Method to set client login credentials
  95.      *
  96.      * @static
  97.      * @param    string    Client name, currently only 'ftp' is supported
  98.      * @param    string    Username
  99.      * @param    string    Password
  100.      * @return    boolean    True if the given login credentials have been set and are valid
  101.      * @since    1.5
  102.      */
  103.     function setCredentials($client, $user, $pass)
  104.     {
  105.         $return = false;
  106.         $client = strtolower($client);
  107.  
  108.         // Test if the given credentials are valid
  109.         switch ($client)
  110.         {
  111.             case 'ftp':
  112.                 $config =& JFactory::getConfig();
  113.                 $options = array(
  114.                     'enabled'    => $config->getValue('config.ftp_enable'),
  115.                     'host'        => $config->getValue('config.ftp_host'),
  116.                     'port'        => $config->getValue('config.ftp_port'),
  117.                 );
  118.  
  119.                 if ($options['enabled'])
  120.                 {
  121.                     jimport('joomla.client.ftp');
  122.                     $ftp =& JFTP::getInstance($options['host'], $options['port']);
  123.  
  124.                     // Test the conection and try to log in
  125.                     if ($ftp->isConnected())
  126.                     {
  127.                         if ($ftp->login($user, $pass)) {
  128.                             $return = true;
  129.                         }
  130.                         $ftp->quit();
  131.                     }
  132.                 }
  133.                 break;
  134.  
  135.             default:
  136.                 break;
  137.         }
  138.  
  139.         if ($return) {
  140.             // Save valid credentials to the session
  141.             $session =& JFactory::getSession();
  142.             $session->set($client.'.user', $user, 'JClientHelper');
  143.             $session->set($client.'.pass', $pass, 'JClientHelper');
  144.  
  145.             // Force re-creation of the data saved within JClientHelper::getCredentials()
  146.             JClientHelper::getCredentials($client, true);
  147.         }
  148.  
  149.         return $return;
  150.     }
  151.  
  152.     /**
  153.      * Method to determine if client login credentials are present
  154.      *
  155.      * @static
  156.      * @param    string    Client name, currently only 'ftp' is supported
  157.      * @return    boolean    True if login credentials are available
  158.      * @since    1.5
  159.      */
  160.     function hasCredentials($client)
  161.     {
  162.         $return = false;
  163.         $client = strtolower($client);
  164.  
  165.         // Get (unmodified) credentials for this client
  166.         switch ($client)
  167.         {
  168.             case 'ftp':
  169.                 $config =& JFactory::getConfig();
  170.                 $options = array(
  171.                     'enabled'    => $config->getValue('config.ftp_enable'),
  172.                     'user'        => $config->getValue('config.ftp_user'),
  173.                     'pass'        => $config->getValue('config.ftp_pass')
  174.                 );
  175.                 break;
  176.  
  177.             default:
  178.                 $options = array(
  179.                     'enabled'    => false,
  180.                     'user'        => '',
  181.                     'pass'        => ''
  182.                 );
  183.                 break;
  184.         }
  185.  
  186.         if ($options['enabled'] == false)
  187.         {
  188.             // The client is disabled in global config, so let's pretend we are OK
  189.             $return = true;
  190.         }
  191.         else if ($options['user'] != '' && $options['pass'] != '')
  192.         {
  193.             // Login credentials are available in global config
  194.             $return = true;
  195.         }
  196.         else
  197.         {
  198.             // Check if login credentials are available in the session
  199.             $session =& JFactory::getSession();
  200.             $user = $session->get($client.'.user', null, 'JClientHelper');
  201.             $pass = $session->get($client.'.pass', null, 'JClientHelper');
  202.             if ($user != '' && $pass != '') {
  203.                 $return = true;
  204.             }
  205.         }
  206.  
  207.         return $return;
  208.     }
  209.  
  210.     /**
  211.      * Determine wether input fields for client settings need to be shown
  212.      *
  213.      * If valid credentials were passed along with the request, they are saved to the session.
  214.      * This functions returns an exeption if invalid credentials have been given or if the
  215.      * connection to the server failed for some other reason.
  216.  
  217.      * @static
  218.      * @return    boolean|JExeption   True, if FTP settings should be shown, or an exeption
  219.      * @since    1.5
  220.      */
  221.     function &setCredentialsFromRequest($client)
  222.     {
  223.         // Determine wether FTP credentials have been passed along with the current request
  224.         $user = JRequest::getVar('username', null, 'POST');
  225.         $pass = JRequest::getVar('password', null, 'POST');
  226.         if ($user != '' && $pass != '')
  227.         {
  228.             // Add credentials to the session
  229.             if (JClientHelper::setCredentials($client, $user, $pass)) {
  230.                 $return = false;
  231.             } else {
  232.                 $return =& JError::raiseWarning('SOME_ERROR_CODE', 'JClientHelper::setCredentialsFromRequest failed');
  233.             }
  234.         }
  235.         else
  236.         {
  237.             // Just determine if the FTP input fields need to be shown
  238.             $return = !JClientHelper::hasCredentials('ftp');
  239.         }
  240.  
  241.         return $return;
  242.     }
  243. }
  244. ?>
Documentation generated on Mon, 05 Mar 2007 21:06:02 +0000 by phpDocumentor 1.3.1