FckeditorModule: fckeditor.py

from cherrypy.lib import httptools
import os.path
import os
from cherrypy import cpg

import mimetypes


contenthomedir='content/' #path were your page created with FCKeditor will reside
fckeditorhomedir="FCKeditor/" #Path where FCKeditor resides
imageshomedir="images/" #don't forget to create this folder for images
#WARNING: adapt your config.conf accordingly



def normpath(path):
    "Just to avoid malicious urls ;-)"
    path=path.replace('..','')
    path=os.path.normpath(path)
    return path
    
class Editor:
    def add(self,page=None):
        "Just to add a page. Require page paramter"
        if not page: return
        return template % {'content':'','page':page}        
    add.exposed=True
    
    def save(self,FCKeditor1,page):
        "Save the generate html page with FCKeditor and immediately redirect to root page"
        page=normpath(page)
        fpath=contenthomedir+page
        if not os.path.isdir(os.path.dirname(fpath)):
            os.makedirs(os.path.dirname(fpath))
        fid=open(fpath,'w')
        fid.write(FCKeditor1)
        fid.close()
        httptools.redirect('/')
    save.exposed=True
    
    def edit(self,page):
        "edit an exisiting page that must reside in <contenthomedir>"
        page=normpath(page)
        fpath=contenthomedir+page
        if not os.path.isfile(fpath):
            return "The page %s is not existing" % fpath
        content=open(fpath).read()
        content=content.replace("\'","\\'")
        return template % {'content':content,'page':page}
    edit.exposed=True
        
    def default(self,*lw,**kw):
        "Method to just display your created web pages"
        path=normpath('/'.join(lw))
        return open(contenthomedir+path).read()
    default.exposed=True
    
    def connector(self,*lw,**kw):
        "Required method by FCKeditor"
        res=""
        if kw.has_key('Command') and kw['Command']=='GetFoldersAndFiles':
            cpg.response.headerMap['Content-Type']='text/xml'
            cpg.response.headerMap['Cache-Control']='no-store, no-cache, must-revalidate'
            cpg.response.headerMap['Pragma']='no-cache'
            kw['imageshomedir']=imageshomedir
            res="""<?xml version="1.0" encoding="utf-8" ?>
                    <Connector command="%(Command)s" resourceType="%(Type)s">
                     <CurrentFolder path="%(CurrentFolder)s" url="/%(imageshomedir)s%(CurrentFolder)s" /> """ % kw
            fpath=kw['CurrentFolder']
            if fpath[0]=='/': fpath=fpath[1:]
            fdirpath=os.path.join(imageshomedir,fpath)
            tmpfoldersxml=""
            tmpfilesxml=""
            for elem in os.listdir(fdirpath):
                fpath=os.path.join(fdirpath,elem)
                if os.path.isdir(fpath):
                    #TODO: convert elem to xml string
                    tmpfoldersxml+="""<Folder name="%s" />""" % (elem)
                elif os.path.isfile(fpath):
                    #TODO: convert elem to xml string
                    tmpfilesxml+="""<File name="%s" size="%s" />""" % (elem,os.stat(fpath)[6]/1024)
            res+="""<Folders>%s</Folders>""" % tmpfoldersxml
            res+="""<Files>%s</Files>""" % tmpfilesxml
            res+="</Connector>"
        
        if kw.has_key('Command') and kw['Command']=='GetFolders':
            cpg.response.headerMap['Content-Type']='text/xml'
            cpg.response.headerMap['Cache-Control']='no-store, no-cache, must-revalidate'
            cpg.response.headerMap['Pragma']='no-cache'
            kw['imageshomedir']=imageshomedir
            res="""<?xml version="1.0" encoding="utf-8" ?>
                    <Connector command="%(Command)s" resourceType="%(Type)s">
                     <CurrentFolder path="%(CurrentFolder)s" url="/%(imageshomedir)s%(CurrentFolder)s" /> """ % kw
            fpath=kw['CurrentFolder']
            if fpath[0]=='/': fpath=fpath[1:]
            fdirpath=os.path.join(imageshomedir,fpath)
            tmpxml=""
            for elem in os.listdir(fdirpath):
                fpath=os.path.join(fpath,elem)
                if os.path.isdir(fpath):
                    #TODO: convert elem to xml string
                    tmpxml+="""<Folder name="%s" />""" % (elem)
            res+="""<Folders>%s</Folders>""" % tmpxml
            res+="</Connector>"
        
        if kw.has_key('Command') and kw['Command']=='FileUpload':
            errorcode=0
            #TODO: manage error code
            filename=cpg.request.filenameMap.get('NewFile',os.tempnam('.','tmp'))
            fdirpath=kw.get('CurrentFolder','')
            if fdirpath[0]=='/': fdirpath=fdirpath[1:]
            fdirpath=os.path.join(imageshomedir,fdirpath)
            fid=open(os.path.join(fdirpath,filename),'wb')
            fid.write(kw['NewFile'])
            fid.close()
            res="""<script type="text/javascript">"""
            res+="""window.parent.frames["frmUpload"].OnUploadCompleted(%s,"%s") ;""" % (errorcode,filename)
            res+="</script>"
        if kw.has_key('Command') and kw['Command']=='CreateFolder':
            cpg.response.headerMap['Content-Type']='text/xml'
            cpg.response.headerMap['Cache-Control']='no-store, no-cache, must-revalidate'
            cpg.response.headerMap['Pragma']='no-cache'
            #TODO: manage errors
            errorcode=0
            errormsg=""
            curdir=kw['CurrentFolder']
            if curdir[0]=='/': curdir=curdir[1:]
            fdirpath=os.path.join(imageshomedir,curdir,kw['NewFolderName'])
            os.mkdir(fdirpath)
            res="""'<Error number="%s" originalDescription="%s" />""" % (errorcode,errormsg)
        if res:
            return res
    connector.exposed=True
    
template="""
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
        <head>
                <title>FCKeditor - Sample</title>
                <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
                <meta name="robots" content="noindex, nofollow">
                <link href="/fck/_samples/sample.css" rel="stylesheet" type="text/css" />
                <script type="text/javascript" src="/fck/fckeditor.js"></script>
                <script type="text/javascript">

function FCKeditor_OnComplete( editorInstance )
{
        window.status = editorInstance.Description ;
}

                </script>

        </head>
        <body>
                <h1>FCKeditor - Javascript</h1>
                <hr>
                <form action="/editor/save" method="post">
                        <script type="text/javascript">
<!--
// Automatically calculates the editor base path based on the _samples directory.
// This is usefull only for these samples. A real application should use something like this:
// oFCKeditor.BasePath = '/fckeditor/' ;        // '/fckeditor/' is the default value.
//var sBasePath = document.location.pathname.substring(0,document.location.pathname.lastIndexOf('_samples')) ;

var oFCKeditor = new FCKeditor( 'FCKeditor1' ) ;
oFCKeditor.BasePath     = '/fck/' ;
oFCKeditor.Height = 400 ;
oFCKeditor.Value        = '%(content)s' ;
oFCKeditor.Create() ;
//-->
                        </script>
                        <br>
                        <input type="hidden" name="page" value="%(page)s" />
                        <input type="submit" value="Submit" />
                </form>
        </body>
</html>
"""

class FCK:
    def default(self,*lw,**kw):
        "This is a twist to provide static content of FCKeditor-2.0RC2 which contains ? and & characters and should not"
        page=fckeditorhomedir+os.sep.join(lw) 
        # Set content-type based on filename extension
        i = page.rfind('.')
        if i != -1: 
            ext = page[i:]
        else: 
            ext = ""
        contentType = mimetypes.types_map.get(ext, "text/plain")
        cpg.response.headerMap['Content-Type'] = contentType
        return open(page,'rb').read()
    default.exposed= True




if __name__=="__main__":
    class Root:
        def index(self):
            return """<html><body>
                   To create your fisrt page: <a href="editor/add?page=test.html">here</a><br>
                   Then you can view the result <a href="content/test.html">here</a><br>
                   Then you can edit it: <a href="editor/edit?page=test.html">here</a>
                   </body></html>"""
        index.exposed=True
    cpg.root=Root()
    cpg.root.editor=Editor() 
    cpg.root.fck=FCK() #according to <Template> FCKeditor is visible via /fck
    cpg.server.start(configFile='config.conf')
    #You should have a config.conf like following:
    #[staticContent]
    #content=content
    #images=images