codebrainz/gist:1009404

## gistfile1.py
#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
#  archive.py
#
#  Copyright 2011 Matthew Brush <mbrush@codebrainz.ca>
#
#  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.
#

import os
import sys
import cgi
import cgitb
import tarfile
from cStringIO import StringIO

################################################################################
# Make sure to configure these when deploying!
#-------------------------------------------------------------------------------
# Use this for debugging:
cgitb.enable()
# Use this for production:
# cgitb.enable(display=0, logdir="/tmp")
# Set to the root of the files:
LOCAL_FOLDER = "/home/mbrush/Projects/Geany/geany-tags"
################################################################################

PROTOCOL = "https" if "https" in os.environ["SERVER_PROTOCOL"].lower() else "http"
FILENAME_FILTERS = [ ".tags" ]
MIME_FORMAT = "application/octect-stream"
ARCHIVE_DIR = "tags"

VALID_LANGS = [
"abc", "actionscript", "ada", "asm", "c", "c#", "c++", "caml", "cmake",
"cobol", "conf", "css", "d", "diff", "docbook", "erlang", "f77", "ferite",
"forth", "fortran", "freebasic", "genie", "glsl", "haskell", "haxe",
"html", "java", "javascript", "latex", "lisp", "lua", "make", "markdown",
"matlab", "nsis", "pascal", "perl", "php", "po", "python", "r", "rest",
"ruby", "scala", "sh", "sql", "tcl", "txt2tags", "vala", "verilog", "vhdl",
"xml", "yaml"
]

FORMATS = {
	"tar":		(".tar", "w"),
	"bz2":		(".tar.bz2", "w:bz2"),
	"bzip2":	(".tar.bz2", "w:bz2"),
	"gzip":		(".tar.gz", "w:gz"),
	"gz":		(".tar.gz", "w:gz"),
	"tgz":		(".tgz", "w:gz")
}


def print_header(mime_type, fn, length):
	" Outputs HTTP headers to tell the browser what to expect. "
	header = """Content-Type: %s
Content-Disposition: attachment; filename=%s
Content-Length: %d

""" % (mime_type, fn, length)
	sys.stdout.write(header)


def print_data(buf):
	"""
	Writes the data from a StringIO() object to the browser.  Make sure to
	call print_header() before calling this function.
	"""
	sys.stdout.write(buf.getvalue())


def print_error(msg):
	"""
	Writes an HTML error page containing msg to the browser.  Don't call this
	after calling print_header() since it sends it's own (different) header.
	"""
	content = """Content-Type: text/html

<html>
	<head>
		<title>Error</title>
	</head>
	<body>
		<h1 style="color: red">Error</h1>
		<p>%s</p>
		<p>See the <a href="%s://%s%s?help">help page</a> for usage information.</p>
	</body>
</html>""" % (msg, PROTOCOL, os.environ["SERVER_NAME"], os.environ["SCRIPT_NAME"])
	sys.stdout.write(content)


def print_help():
	" Writes an HTML help page describing the arguments used with this script. "
	content = """Content-Type: text/html

<html>
	<head>
		<title>Help</title>
	</head>
	<body>
		<h1>Help</h1>

		<h4>Usage:</h4>
		<code>%s://%s%s?language=[language]&format=[format]&tarbomb=[tarbomb]&help</code>

		<p>To use this script, use any or all of the following arguments:</p>

		<ul>
			<li>
				<code>language</code> - The language of the tag files to download
				which defaults to <code>all</code> if left blank.  Allowed values:
				<p><code>all, %s</code></p>
			</li>
			<li>
				<code>format</code> - Format of the archive file to download
				which defaults to <code>bzip2</code> (.tar.bz2).  Allowed values:
				<p><code>%s</code></p>
			</li>
			<li>
				<code>tarbomb</code> - Whether to place all the files in the
				root of the archive or in a subdir.  If tarbomb is
				<code>true</code>, when you extract the archive in the usual
				way, all of the files will be in your current working directory.
				Allowed values:
				<p><code>true, false</code></p>
			</li>
			<li><code>help</code> - Shows this help page.</li>
		</ul>
	</body>
</html>""" % (PROTOCOL, os.environ["SERVER_NAME"], os.environ["SCRIPT_NAME"],
				', '.join(VALID_LANGS), ', '.join(FORMATS.keys()))
	sys.stdout.write(content)


def find_files(base_dir=LOCAL_FOLDER, filters=FILENAME_FILTERS):
	" Find all files (recursively) in base_dir that match any of the filters. "
	for base, dirs, files in os.walk(base_dir):
		for f in files:
			if any(f.endswith(ext) for ext in filters):
				yield os.path.join(base, f)


def file_size(fobj):
	" Get the size in bytes of a file object. "
	fobj.seek(0, 2)
	size = fobj.tell()
	fobj.seek(0, 0)
	return size


def create_archive(fmt, base_dir=LOCAL_FOLDER, filters=FILENAME_FILTERS, tarbomb=False):
	"""
	Archive (and possibly compress) all the files in base_dir which match
	filters.  fmt decides which type of tarball to make (tar, bz2, gzip), and
	tarbomb is whether to put files in the root of the archive.
	"""
	if fmt in FORMATS.keys():
		memfile = StringIO()
		tfile = tarfile.open(fileobj=memfile, mode=FORMATS[fmt][1])
		for f in find_files(base_dir, filters):
			if tarbomb:
				tfile.add(f, os.path.basename(f))
			else:
				tfile.add(f, os.path.join(ARCHIVE_DIR, os.path.basename(f)))
		tfile.close()
		return memfile
	else: return None


def main():

	form = cgi.FieldStorage(keep_blank_values=True)

	if "help" in form:
		print_help()
		exit(0)

	tarbomb = form["tarbomb"].value if "tarbomb" in form else "false"

	if "fmt" in form:
		fmt = form["fmt"].value
	elif "format" in form:
		fmt = form["format"].value
	else: fmt = "bz2"

	if "lang" in form:
		lang = form["lang"].value
	elif "language" in form:
		lang = form["language"].value
	else: lang = "all"

	if fmt not in FORMATS.keys():
		print_error(
			"Unknown format '%s' specified, please use one of: <p><code>%s</code></p>" %
			(fmt, ', '.join(sorted(FORMATS.keys()))))
		exit(1)

	if lang != "all" and lang not in VALID_LANGS:
		print_error(
			"Unknown language '%s' specified, please use one of: <p><code>all, %s</code></p>" %
			(lang, ', '.join(sorted(VALID_LANGS))))
		exit(1)

	if any(tarbomb == v for v in ["true", "TRUE", "yes", "YES"]):
		tarbomb = True
	else: tarbomb = False

	if lang == "all":
		fn = "geany-tags%s" % FORMATS[fmt][0]
		archive = create_archive(fmt, LOCAL_FOLDER, FILENAME_FILTERS, tarbomb)
	else:
		fn = "geany-%s-tags%s" % (lang, FORMATS[fmt][0])
		filts = [ ".%s%s" % (lang, f) for f in FILENAME_FILTERS ]
		archive = create_archive(fmt, LOCAL_FOLDER, filts, tarbomb)

	if archive is None:
		print_error("Unable to create archive.")
		exit(1)

	print_header(MIME_FORMAT, fn, file_size(archive))
	print_data(archive)

	archive.close()


if __name__ == "__main__": main()
	#!/usr/bin/env python
	# -- coding: utf-8 --
	#
	# archive.py
	#
	# Copyright 2011 Matthew Brush <mbrush@codebrainz.ca>
	#
	# 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.
	#

	import os
	import sys
	import cgi
	import cgitb
	import tarfile
	from cStringIO import StringIO

	################################################################################
	# Make sure to configure these when deploying!
	#-------------------------------------------------------------------------------
	# Use this for debugging:
	cgitb.enable()
	# Use this for production:
	# cgitb.enable(display=0, logdir="/tmp")
	# Set to the root of the files:
	LOCAL_FOLDER = "/home/mbrush/Projects/Geany/geany-tags"
	################################################################################

	PROTOCOL = "https" if "https" in os.environ["SERVER_PROTOCOL"].lower() else "http"
	FILENAME_FILTERS = [ ".tags" ]
	MIME_FORMAT = "application/octect-stream"
	ARCHIVE_DIR = "tags"

	VALID_LANGS = [
	"abc", "actionscript", "ada", "asm", "c", "c#", "c++", "caml", "cmake",
	"cobol", "conf", "css", "d", "diff", "docbook", "erlang", "f77", "ferite",
	"forth", "fortran", "freebasic", "genie", "glsl", "haskell", "haxe",
	"html", "java", "javascript", "latex", "lisp", "lua", "make", "markdown",
	"matlab", "nsis", "pascal", "perl", "php", "po", "python", "r", "rest",
	"ruby", "scala", "sh", "sql", "tcl", "txt2tags", "vala", "verilog", "vhdl",
	"xml", "yaml"
	]

	FORMATS = {
	"tar": (".tar", "w"),
	"bz2": (".tar.bz2", "w:bz2"),
	"bzip2": (".tar.bz2", "w:bz2"),
	"gzip": (".tar.gz", "w:gz"),
	"gz": (".tar.gz", "w:gz"),
	"tgz": (".tgz", "w:gz")
	}


	def print_header(mime_type, fn, length):
	" Outputs HTTP headers to tell the browser what to expect. "
	header = """Content-Type: %s
	Content-Disposition: attachment; filename=%s
	Content-Length: %d

	""" % (mime_type, fn, length)
	sys.stdout.write(header)


	def print_data(buf):
	"""
	Writes the data from a StringIO() object to the browser. Make sure to
	call print_header() before calling this function.
	"""
	sys.stdout.write(buf.getvalue())


	def print_error(msg):
	"""
	Writes an HTML error page containing msg to the browser. Don't call this
	after calling print_header() since it sends it's own (different) header.
	"""
	content = """Content-Type: text/html

	<html>
	<head>
	<title>Error</title>
	</head>
	<body>
	<h1 style="color: red">Error</h1>
	<p>%s</p>
	<p>See the <a href="%s://%s%s?help">help page</a> for usage information.</p>
	</body>
	</html>""" % (msg, PROTOCOL, os.environ["SERVER_NAME"], os.environ["SCRIPT_NAME"])
	sys.stdout.write(content)


	def print_help():
	" Writes an HTML help page describing the arguments used with this script. "
	content = """Content-Type: text/html

	<html>
	<head>
	<title>Help</title>
	</head>
	<body>
	<h1>Help</h1>

	<h4>Usage:</h4>
	<code>%s://%s%s?language=[language]&format=[format]&tarbomb=[tarbomb]&help</code>

	<p>To use this script, use any or all of the following arguments:</p>

	<ul>
	<li>
	<code>language</code> - The language of the tag files to download
	which defaults to <code>all</code> if left blank. Allowed values:
	<p><code>all, %s</code></p>
	</li>
	<li>
	<code>format</code> - Format of the archive file to download
	which defaults to <code>bzip2</code> (.tar.bz2). Allowed values:
	<p><code>%s</code></p>
	</li>
	<li>
	<code>tarbomb</code> - Whether to place all the files in the
	root of the archive or in a subdir. If tarbomb is
	<code>true</code>, when you extract the archive in the usual
	way, all of the files will be in your current working directory.
	Allowed values:
	<p><code>true, false</code></p>
	</li>
	<li><code>help</code> - Shows this help page.</li>
	</ul>
	</body>
	</html>""" % (PROTOCOL, os.environ["SERVER_NAME"], os.environ["SCRIPT_NAME"],
	', '.join(VALID_LANGS), ', '.join(FORMATS.keys()))
	sys.stdout.write(content)


	def find_files(base_dir=LOCAL_FOLDER, filters=FILENAME_FILTERS):
	" Find all files (recursively) in base_dir that match any of the filters. "
	for base, dirs, files in os.walk(base_dir):
	for f in files:
	if any(f.endswith(ext) for ext in filters):
	yield os.path.join(base, f)


	def file_size(fobj):
	" Get the size in bytes of a file object. "
	fobj.seek(0, 2)
	size = fobj.tell()
	fobj.seek(0, 0)
	return size


	def create_archive(fmt, base_dir=LOCAL_FOLDER, filters=FILENAME_FILTERS, tarbomb=False):
	"""
	Archive (and possibly compress) all the files in base_dir which match
	filters. fmt decides which type of tarball to make (tar, bz2, gzip), and
	tarbomb is whether to put files in the root of the archive.
	"""
	if fmt in FORMATS.keys():
	memfile = StringIO()
	tfile = tarfile.open(fileobj=memfile, mode=FORMATS[fmt][1])
	for f in find_files(base_dir, filters):
	if tarbomb:
	tfile.add(f, os.path.basename(f))
	else:
	tfile.add(f, os.path.join(ARCHIVE_DIR, os.path.basename(f)))
	tfile.close()
	return memfile
	else: return None


	def main():

	form = cgi.FieldStorage(keep_blank_values=True)

	if "help" in form:
	print_help()
	exit(0)

	tarbomb = form["tarbomb"].value if "tarbomb" in form else "false"

	if "fmt" in form:
	fmt = form["fmt"].value
	elif "format" in form:
	fmt = form["format"].value
	else: fmt = "bz2"

	if "lang" in form:
	lang = form["lang"].value
	elif "language" in form:
	lang = form["language"].value
	else: lang = "all"

	if fmt not in FORMATS.keys():
	print_error(
	"Unknown format '%s' specified, please use one of: <p><code>%s</code></p>" %
	(fmt, ', '.join(sorted(FORMATS.keys()))))
	exit(1)

	if lang != "all" and lang not in VALID_LANGS:
	print_error(
	"Unknown language '%s' specified, please use one of: <p><code>all, %s</code></p>" %
	(lang, ', '.join(sorted(VALID_LANGS))))
	exit(1)

	if any(tarbomb == v for v in ["true", "TRUE", "yes", "YES"]):
	tarbomb = True
	else: tarbomb = False

	if lang == "all":
	fn = "geany-tags%s" % FORMATS[fmt][0]
	archive = create_archive(fmt, LOCAL_FOLDER, FILENAME_FILTERS, tarbomb)
	else:
	fn = "geany-%s-tags%s" % (lang, FORMATS[fmt][0])
	filts = [ ".%s%s" % (lang, f) for f in FILENAME_FILTERS ]
	archive = create_archive(fmt, LOCAL_FOLDER, filts, tarbomb)

	if archive is None:
	print_error("Unable to create archive.")
	exit(1)

	print_header(MIME_FORMAT, fn, file_size(archive))
	print_data(archive)

	archive.close()


	if __name__ == "__main__": main()