ftp_publish_helper.py

#-*- coding: utf-8 -*-
"""
@file
@brief Helpers to publish the documentation of python to a website
"""

import os
from pyquickhelper import TransferFTP, FileTreeNode, FolderTransferFTP, open_window_params
from pyquickhelper.filehelper.ftp_transfer_files import content_as_binary

def trigger_on_specific_strings(content):
    """
    look for specific string such as *USERNAME*, *USERDNSDOMAIN*, *HOMEPATH*, *USERNAME*,
                *COMPUTERNAME*, *LOGONSERVER*, and returns None if it was found
    or modifies the content to remove it
    """
    lower_content = content.lower()
    for st in ["USERNAME", "USERDNSDOMAIN", "HOMEPATH", "USERNAME",
                "COMPUTERNAME", "LOGONSERVER"]:
        s = os.environ[st].lower()
        if s in lower_content:
            return None
    return content

def publish_documentation(
                docs,
                ftpsite         = None,
                login           = None,
                password        = None,
                key_save        = "my_password",
                footer_html     = None,
                content_filter  = trigger_on_specific_strings,
                is_binary       = content_as_binary,
                fLOG            = print
                ):
    """
    publish the documentation and the setups of a python module on a webiste,
    it assumes the modules is organized the same way as 
    `pyquickhelper <http://www.xavierdupre.fr/app/pyquickhelper/helpsphinx/index.html>`_.
    
    @param      docs            list of dictionaries (see below)
    @param      ftpsite         something like ``ftp.something.``
    @param      login           login
    @param      password        password
    @param      key_save        see function `open_window_params <http://www.xavierdupre.fr/app/pyquickhelper/helpsphinx/pyquickhelper/funcwin/frame_params.html#pyquickhelper.funcwin.frame_params.open_window_params>`_
    @param      footer_html     append this HTML code to any uploaded page (such a javascript code to count the audience)
    @param      content_filter  filter the content of a file (it raises an exception if the result is None),
                                appies only on text files
    @param      is_binary       a function to tell if a content of a file is binary or not
    @param      fLOG            logging function
    
    *docs* is a list of dictionaries which must contain for each folder
    to transfer:
        - ``local``: local folder
        - ``root_local``: local paths will be related to this root
        - ``root_web``: prefix to add to the remote paths
        - ``status_file``: a file where the function populates the transfered files and some information about them
        
    A local file is composed by ``<local_root>/<relative_path>``, it
    will be uploaded to ``<web_root>/<relative_path>``.
    
    If one of the three first parameters is None, the function
    will open a popup windows to ask the missing information.
    See `open_window_params <http://www.xavierdupre.fr/app/pyquickhelper/helpsphinx/pyquickhelper/funcwin/frame_params.html#pyquickhelper.funcwin.frame_params.open_window_params>`_.
    """
                    
    params = {"ftpsite":ftpsite,
              "login":login,
              "password":password,
              }
              
    nbnone = len ( [ v for k,v in params.items() if v is None or len(v) == 0 ] )
    if nbnone > 0:
        params = open_window_params (params, title="Website and Credentials", help_string = "ftp site + login + password", key_save=key_save)
        
    nbnone = [ v for k,v in params.items() if v is None or len(v) == 0 ]
    if len(nbnone) > 0:
        raise Exception("one of the parameters is None:\n" + str(nbnone))
        
    password = params["password"]
    login = params["login"]
    ftpsite = params["ftpsite"]
    
    ftp = TransferFTP(ftpsite, 
                    login, 
                    password, 
                    fLOG=fLOG)
                    
    for project in docs:
        
        location = project["local"]
        root_local = project["root_local"]
        root_web = project["root_web"]
                
        fLOG("-------------------------",location)

        sfile = project["status_file"]
        rootw = project["root_web"]
        
        ftn  = FileTreeNode(root_local)
        fftp = FolderTransferFTP (ftn, ftp, sfile, 
                            root_web = rootw,
                            fLOG=fLOG,
                            footer_html = footer_html,
                            content_filter=content_filter,
                            is_binary=is_binary)

        fftp.start_transfering()
        
        ftn  = FileTreeNode(os.path.join(root_local,".."), 
                            filter = lambda root, path, f, dir: not dir)
        fftp = FolderTransferFTP (ftn, ftp, sfile, 
                            root_web = root_web.replace("helpsphinx",""),
                            fLOG=fLOG,
                            footer_html = footer_html,
                            content_filter=content_filter,
                            is_binary=is_binary)

        fftp.start_transfering()
        

    ftp.close()