FTPConnector.py 3.91 KB
# -*- coding: utf-8 -*-
##############################################################################
#
# Copyright (c) 2013 Nexedi SA and Contributors. All Rights Reserved.
#                    Aurélien Calonne <aurel@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsibility of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# guarantees and support are strongly adviced to contract a Free Software
# Service Company
#
# 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 2
# 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, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
##############################################################################

from AccessControl import ClassSecurityInfo
from Products.CMFCore.utils import getToolByName
from Products.ERP5Type import Permissions, PropertySheet, Constraint, interfaces
from Products.ERP5Type.XMLObject import XMLObject

class FTPConnector(XMLObject):
  # CMF Type Definition
  meta_type = 'FTP Connector'
  portal_type = 'FTP Connector'

  # Declarative security
  security = ClassSecurityInfo()
  security.declareObjectProtected(Permissions.AccessContentsInformation)

  # Default Properties
  property_sheets = ( PropertySheet.Base
                    , PropertySheet.XMLObject
                    , PropertySheet.CategoryCore
                    , PropertySheet.DublinCore
                      )

  def getConnection(self):
    if self.getUrlProtocol() == "sftp":
      return self.getPortalObject().portal_web_services.connect(
        user_name=self.getUserId(),
        password=self.getPassword(),
        url=self.getUrlString(),
        transport=self.getUrlProtocol(),
        transport_kw={"private_key":self.getDescription(),},)
    else:
      # XXX Must manage in the future ftp and ftps protocol
      raise NotImplementedError("Protocol %s is not yet implemented" %(self.getUrlProtocol(),))

  def renameFile(self, old_path, new_path):
    """ Move a file """
    conn = self.getConnection()
    try:
      conn.renameFile(old_path, new_path)
    finally:
      conn.logout()

  def removeFile(self, filepath):
    """Delete the file"""
    conn = self.getConnection()
    try:
      conn.removeFile(filepath)
    finally:
      conn.logout()

  def listFiles(self, path="."):
    """ List file of a directory """
    conn = self.getConnection()
    try:
      return conn.getDirectoryContent(path)
    finally:
      conn.logout()

  def getFile(self, filepath, binary=False):
    """ Try to get a file on the remote server """
    conn = self.getConnection()
    try:
      if binary:
        return conn.readBinaryFile(filepath)
      else:
        return conn.readAsciiFile(filepath)
    finally:
      conn.logout()

  def putFile(self, filename, data, remotepath='.'):
    """ Send file to the remote server """
    conn = self.getConnection()
    try:
      if self.isUseTemporaryFileOnWrite():
        # Simulation transaction system
        conn.writeFile(remotepath, '%s.tmp' % filename, data)
        self.activate(activity='SQLQueue').renameFile('%s/%s.tmp' % (remotepath, filename),
                                                      '%s/%s' % (remotepath, filename))
      else:
        conn.writeFile(remotepath, '%s' % filename, data)
    finally:
      conn.logout()