Zolomon.com

(Really tired at the time of writing - if you see any obvious improvements, by all means, let me know!) Recently I've been working double time - and to cram even more productivity into my schedule I've moved from developing on my PC to my MAC. I have also made the transition from manual .css-editing ...

(Really tired at the time of writing – if you see any obvious improvements, by all means, let me know!)

Recently I’ve been working double time – and to cram even more productivity into my schedule I’ve moved from developing on my PC to my MAC. I have also made the transition from manual .css-editing to the use of www.sass-lang.com which is a real time-saver! The beauty with the tool, Sass/scss (Sassy-CSS), is that it compiles your CSS on the fly as soon as it notices a change!

(EDIT: Okay, so lvh just informed me about Less and it kind of wins over Sass if you don’t mind JavaScript! It actually seems like the future, makes my script feel like all for nothing! *sheds a tear*)

Usually I just used FileZilla and my text editor of choice to upload any changes I did. But now, that wasn’t immediately possible. So I thought, since I’m already trying to become better at Python, that I would try and script this!

My thoughts went something like the following:

1. Write some more Sassy CSS
2. Wait for the new css to generate
3. Upload the new/modified css to my specified ftp
4. Refresh website
5. PROFIT!

So high and low, I searched and searched, and IRC:ed and IRC:ed (#python@irc.freenode.net, gorakhargosh & lvh, word up!) – and finally (during my quest I found KQueue, pyinotify – both of which I dismissed due to lack for MAC support) I came across this lovely git (pun intended): https://github.com/gorakhargosh/watchdog (the creator is a totally rad chap!) that provides an awesome API for file based system events! For example; monitoring a directory recursively for file changes (added, deleted, modified, etc!) would be pure cake walk!

So I quickly hacked together (you can’t even imagine how much I learned in one evening – argparser, ConfigParser, ftplib – just to name a few!) this lovely little script (pure hax, but oh my how it works):

The watcher.py

import ConfigParser
import os
import time
import sys
import logging
import argparse

from ftplib import FTP
from watchdog.observers import Observer
from watchdog.events import FileSystemEventHandler

print "REMEMBER TO UPDATE CONFIG FILE AND USE CORRECT [SECTION]"

logging.basicConfig(level=logging.DEBUG)

class MyEventHandler(FileSystemEventHandler):
    """Custom EventHandler"""
    def catch_all_handler(self, event):
        logging.debug(event)

    def on_moved(self, event):
        self.catch_all_handler(event)

    def on_created(self, event):
        self.catch_all_handler(event)

    def on_deleted(self, event):
        self.catch_all_handler(event)

    def on_modified(self, event):
        global ext
        self.catch_all_handler(event)
        fileextension = os.path.splitext(event.src_path)[-1]
        if fileextension in extensions.split(';'):
            ftpLogin()
            ftpGoTo(destination)
            ftpUpload(event.src_path)

parser = argparse.ArgumentParser(description='Automatically uploads watched files to specified ftp.')
parser.add_argument('-dir', help='The directory to watch')
parser.add_argument('-cfg', help='The section to use')
args = parser.parse_args()

path = args.dir
print "Current path:", path

# Read config
filename = args.cfg
config = ConfigParser.SafeConfigParser()
config.read(filename)
print "Current config:", filename

# Fetch config data for this project
host = config.get('zolomon.com', 'host')
port = config.get('zolomon.com', 'port')
username = config.get('zolomon.com', 'username')
password = config.get('zolomon.com', 'password')
directory = config.get('zolomon.com', 'dir')
files = config.get('zolomon.com', 'file')
destination = config.get('zolomon.com', 'destination')
extensions = config.get('zolomon.com', 'extensions')

ftp = None # our FTP variable.. It's global, need to learn how to unuglify this!

def ftpLogin():
    """Log in"""
    global ftp
    try:
        ftp = FTP(host, username, password)
        print "logged in"
    except (socket.error, socket.gaierror), e:
        print 'ERROR: cannot login anonymously'
        ftp.quit()
        exit()
        print '*** Logged in as', username

def ftpGoTo(path):
    """Go to this path"""
    global ftp
    try:
        ftp.cwd(path) # Change working directory...
        print "changed path"
    except ftplib.error_perm:
        print 'ERROR: cannot CD to "%s"' % destination
        ftp.quit()
        exit()
        print '*** Changed dir to "%s"' % ftp.pwd()

def ftpUpload(file):
    """Upload this file"""
    global ftp
    if os.path.exists(file):
        ext = os.path.splitext(file)[1]
        try:
            if ext in (".css", ".htm", ".html", ".php"):
                ftp.storlines("STOR " + destination + file.split('/')[-1], open(file))
            else:
                # If it's something else, it's probably a binary file
                ftp.storbinary("STOR " + destination + file.split('/')[-1], open(file, "rb"), 1024)
            print "uploaded %s" % file
        except ftplib.error_perm:
            print 'Error: cannot store file "%s"' % file
            os.unlink(directory + file)
        else:
            print '*** Uploaded "%s"' % file

event_handler = MyEventHandler()
observer = Observer()
observer.schedule(event_handler, path, recursive=True)
observer.start()
try:
    while True:
        time.sleep(1)
except KeyboardInterrupt:
    observer.stop()
    ftp.quit()
observer.join()

And to use it I created a tiny app to create a config file; behold – the new_config.py!

import ConfigParser

config = ConfigParser.RawConfigParser()

config.add_section('zolomon.com') # section name (I can just copy this for every site!)
config.set('zolomon.com', 'host', 'ftp.hosturl.com') # ftp host
config.set('zolomon.com', 'port', '21') # ftp port
config.set('zolomon.com', 'username', 'EnterHackerAlias') # zolomon
config.set('zolomon.com', 'password', 'AristotlesWasAHipster') # He was!
config.set('zolomon.com', 'dir', '/Users/zolomon/Documents/code/web/kettis/') # Same as below
config.set('zolomon.com', 'file', 'style.css;index.php') # Too tired to remember if I actually use these :P
config.set('zolomon.com', 'destination', '/public_html/web/kettis/') # The destination for uploads
config.set('zolomon.com', 'extensions', '.css;.php;.html;.htm') # Extensions to upload into 'destination'

# write config to file
filename = 'zolomon.com.cfg'
with open(filename, 'wb') as configfile:
    config.write(configfile)