ryuslash/hypo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Compare commits

base: ryuslash:master
Branches Tags
ryuslash:master
ryuslash:git
ryuslash:master2
..
compare: ryuslash:master2
Branches Tags
ryuslash:master
ryuslash:git
ryuslash:master2

No commits in common. "master" and "master2" have entirely different histories.
master ... master2

11 changed files with 117 additions and 1106 deletions
Show stats Expand all files Collapse all files

54
README.org
View file

@ -1,12 +1,9 @@
#+STARTUP: showall Quickly share bits of code, screenshots or whatnot with some friends.
#+OPTIONS: toc:nil
Quickly share bits of code, screenshots and whatnot with some friends.
Easily delete them too. Easily delete them too.
* Setup * Setup
Hypo is written in [[http://hylang.org][hy]]. Which is a Lisp and Python thrown together. Hypo is written in [[http://hylang.org][hy]]. Which is a Lisp and Python thrown together.
This doesn't matter much, it should function as a regular python This doesn't matter much, it should function as a regular python
module. module.
@ -14,19 +11,18 @@ Easily delete them too.
Hypo has the following requirements: Hypo has the following requirements:
- [[http://hylang.org][hy]] 0.10.0 :: The language. - [[http://hylang.org][hy]] :: The language.
- [[http://webpy.org][web.py]] 0.37 :: The Python web framework. - [[http://webpy.org][web.py]] :: The Python web framework.
- [[https://github.com/FriendCode/gittle][gittle]] 0.2.2 :: Pythonic Git for Humans - [[http://postgresql.org][Postgresql]] :: The database.
- [[https://bitbucket.org/babab/pycommand][pycommand]] 0.1.0 :: Command line arguments parser - [[http://initd.org/psycopg/][psycopg2]] :: The database connector.
- [[http://pygments.org/][Pygments]] 1.6 :: Python syntax highlighter
Besides these it also requires everything needed to run web.py Besides these it also requires everything needed to run web.py
applications using your favorite webserver. applications using your favorite webserver.
* Usage * Usage
Once setup it will show most of this file if you browse to the ~/~ of Once setup it will not show much of anything, first you'll have to
your installation, then you'll have to upload something. upload something.
** Uploading ** Uploading
@ -45,50 +41,18 @@ Easily delete them too.
If Hypo doens't know what kind of file you're uploading it will If Hypo doens't know what kind of file you're uploading it will
default to treating it as a text file. default to treating it as a text file.
** Viewing
All files can be viewed (from, for example, your web browser) in
three different ways. The regularly, raw and as download.
The regular way shows a web page with the file either syntax
highlighted using ~pygments~ or (in case it is an image) with the
image shown on the page. This is viewed by using the URL printed
after upload has completed. For example:
: http://yourserver.example.com/abcdef1
The raw view is just the file, saving this file is the same as
downloading it. This is viewed by prefixing the last part of the
URL with ~raw/~. For example:
: http://yourserver.example.com/raw/abcdef1
The download view is the same as the raw view except that the
~Content-Disposition~ header has been set to ~attachment~. This causes
a download dialog to show up instead of your browser trying to
render it. This is viewed by prefixing the last part of the URL
with ~dl/~. For example:
: http://yourserver.example.com/dl/abcdef1
** Deleting ** Deleting
After you have uploaded a file you can delete it again by using After you have uploaded a file you can delete it again by using
the ~DELETE~ HTTP method. An example with curl: the ~DELETE~ HTTP method. An example with curl:
: # curl -XDELETE http://yourserver.example.com/abcdef1 : # curl -XDELETE http://yourserver.example.com/abcdef1
: Successfully removed abcdef1 : None
There is currently no way to authenticate yourself with the There is currently no way to authenticate yourself with the
server, so anyone can delete (also post) files. Of course they server, so anyone can delete (also post) files. Of course they
would first have to know the URL to send the delete to. would first have to know the URL to send the delete to.
* Clients
Hypo tries to stay simple to work with, at least on the client-side.
However, some clients may make things easier. Currently there is
only the (incomplete) [[http://code.ryuslash.org/hypo-emacs/][Emacs client]] and a simple [[http://code.ryuslash.org/hypo-cli/about/][CLI client]].
* License * License
Hypo is free software: you can redistribute it and/or modify it Hypo is free software: you can redistribute it and/or modify it

505
doc/fdl.texi
View file

@ -1,505 +0,0 @@
@c The GNU Free Documentation License.
@center Version 1.3, 3 November 2008
@c This file is intended to be included within another document,
@c hence no sectioning command or @node.
@display
Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
@uref{http://fsf.org/}
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
@end display
@enumerate 0
@item
PREAMBLE
The purpose of this License is to make a manual, textbook, or other
functional and useful document @dfn{free} in the sense of freedom: to
assure everyone the effective freedom to copy and redistribute it,
with or without modifying it, either commercially or noncommercially.
Secondarily, this License preserves for the author and publisher a way
to get credit for their work, while not being considered responsible
for modifications made by others.
This License is a kind of ``copyleft'', which means that derivative
works of the document must themselves be free in the same sense. It
complements the GNU General Public License, which is a copyleft
license designed for free software.
We have designed this License in order to use it for manuals for free
software, because free software needs free documentation: a free
program should come with manuals providing the same freedoms that the
software does. But this License is not limited to software manuals;
it can be used for any textual work, regardless of subject matter or
whether it is published as a printed book. We recommend this License
principally for works whose purpose is instruction or reference.
@item
APPLICABILITY AND DEFINITIONS
This License applies to any manual or other work, in any medium, that
contains a notice placed by the copyright holder saying it can be
distributed under the terms of this License. Such a notice grants a
world-wide, royalty-free license, unlimited in duration, to use that
work under the conditions stated herein. The ``Document'', below,
refers to any such manual or work. Any member of the public is a
licensee, and is addressed as ``you''. You accept the license if you
copy, modify or distribute the work in a way requiring permission
under copyright law.
A ``Modified Version'' of the Document means any work containing the
Document or a portion of it, either copied verbatim, or with
modifications and/or translated into another language.
A ``Secondary Section'' is a named appendix or a front-matter section
of the Document that deals exclusively with the relationship of the
publishers or authors of the Document to the Document's overall
subject (or to related matters) and contains nothing that could fall
directly within that overall subject. (Thus, if the Document is in
part a textbook of mathematics, a Secondary Section may not explain
any mathematics.) The relationship could be a matter of historical
connection with the subject or with related matters, or of legal,
commercial, philosophical, ethical or political position regarding
them.
The ``Invariant Sections'' are certain Secondary Sections whose titles
are designated, as being those of Invariant Sections, in the notice
that says that the Document is released under this License. If a
section does not fit the above definition of Secondary then it is not
allowed to be designated as Invariant. The Document may contain zero
Invariant Sections. If the Document does not identify any Invariant
Sections then there are none.
The ``Cover Texts'' are certain short passages of text that are listed,
as Front-Cover Texts or Back-Cover Texts, in the notice that says that
the Document is released under this License. A Front-Cover Text may
be at most 5 words, and a Back-Cover Text may be at most 25 words.
A ``Transparent'' copy of the Document means a machine-readable copy,
represented in a format whose specification is available to the
general public, that is suitable for revising the document
straightforwardly with generic text editors or (for images composed of
pixels) generic paint programs or (for drawings) some widely available
drawing editor, and that is suitable for input to text formatters or
for automatic translation to a variety of formats suitable for input
to text formatters. A copy made in an otherwise Transparent file
format whose markup, or absence of markup, has been arranged to thwart
or discourage subsequent modification by readers is not Transparent.
An image format is not Transparent if used for any substantial amount
of text. A copy that is not ``Transparent'' is called ``Opaque''.
Examples of suitable formats for Transparent copies include plain
ASCII without markup, Texinfo input format, La@TeX{} input
format, SGML or XML using a publicly available
DTD, and standard-conforming simple HTML,
PostScript or PDF designed for human modification. Examples
of transparent image formats include PNG, XCF and
JPG@. Opaque formats include proprietary formats that can be
read and edited only by proprietary word processors, SGML or
XML for which the DTD and/or processing tools are
not generally available, and the machine-generated HTML,
PostScript or PDF produced by some word processors for
output purposes only.
The ``Title Page'' means, for a printed book, the title page itself,
plus such following pages as are needed to hold, legibly, the material
this License requires to appear in the title page. For works in
formats which do not have any title page as such, ``Title Page'' means
the text near the most prominent appearance of the work's title,
preceding the beginning of the body of the text.
The ``publisher'' means any person or entity that distributes copies
of the Document to the public.
A section ``Entitled XYZ'' means a named subunit of the Document whose
title either is precisely XYZ or contains XYZ in parentheses following
text that translates XYZ in another language. (Here XYZ stands for a
specific section name mentioned below, such as ``Acknowledgements'',
``Dedications'', ``Endorsements'', or ``History''.) To ``Preserve the Title''
of such a section when you modify the Document means that it remains a
section ``Entitled XYZ'' according to this definition.
The Document may include Warranty Disclaimers next to the notice which
states that this License applies to the Document. These Warranty
Disclaimers are considered to be included by reference in this
License, but only as regards disclaiming warranties: any other
implication that these Warranty Disclaimers may have is void and has
no effect on the meaning of this License.
@item
VERBATIM COPYING
You may copy and distribute the Document in any medium, either
commercially or noncommercially, provided that this License, the
copyright notices, and the license notice saying this License applies
to the Document are reproduced in all copies, and that you add no other
conditions whatsoever to those of this License. You may not use
technical measures to obstruct or control the reading or further
copying of the copies you make or distribute. However, you may accept
compensation in exchange for copies. If you distribute a large enough
number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and
you may publicly display copies.
@item
COPYING IN QUANTITY
If you publish printed copies (or copies in media that commonly have
printed covers) of the Document, numbering more than 100, and the
Document's license notice requires Cover Texts, you must enclose the
copies in covers that carry, clearly and legibly, all these Cover
Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
the back cover. Both covers must also clearly and legibly identify
you as the publisher of these copies. The front cover must present
the full title with all words of the title equally prominent and
visible. You may add other material on the covers in addition.
Copying with changes limited to the covers, as long as they preserve
the title of the Document and satisfy these conditions, can be treated
as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit
legibly, you should put the first ones listed (as many as fit
reasonably) on the actual cover, and continue the rest onto adjacent
pages.
If you publish or distribute Opaque copies of the Document numbering
more than 100, you must either include a machine-readable Transparent
copy along with each Opaque copy, or state in or with each Opaque copy
a computer-network location from which the general network-using
public has access to download using public-standard network protocols
a complete Transparent copy of the Document, free of added material.
If you use the latter option, you must take reasonably prudent steps,
when you begin distribution of Opaque copies in quantity, to ensure
that this Transparent copy will remain thus accessible at the stated
location until at least one year after the last time you distribute an
Opaque copy (directly or through your agents or retailers) of that
edition to the public.
It is requested, but not required, that you contact the authors of the
Document well before redistributing any large number of copies, to give
them a chance to provide you with an updated version of the Document.
@item
MODIFICATIONS
You may copy and distribute a Modified Version of the Document under
the conditions of sections 2 and 3 above, provided that you release
the Modified Version under precisely this License, with the Modified
Version filling the role of the Document, thus licensing distribution
and modification of the Modified Version to whoever possesses a copy
of it. In addition, you must do these things in the Modified Version:
@enumerate A
@item
Use in the Title Page (and on the covers, if any) a title distinct
from that of the Document, and from those of previous versions
(which should, if there were any, be listed in the History section
of the Document). You may use the same title as a previous version
if the original publisher of that version gives permission.
@item
List on the Title Page, as authors, one or more persons or entities
responsible for authorship of the modifications in the Modified
Version, together with at least five of the principal authors of the
Document (all of its principal authors, if it has fewer than five),
unless they release you from this requirement.
@item
State on the Title page the name of the publisher of the
Modified Version, as the publisher.
@item
Preserve all the copyright notices of the Document.
@item
Add an appropriate copyright notice for your modifications
adjacent to the other copyright notices.
@item
Include, immediately after the copyright notices, a license notice
giving the public permission to use the Modified Version under the
terms of this License, in the form shown in the Addendum below.
@item
Preserve in that license notice the full lists of Invariant Sections
and required Cover Texts given in the Document's license notice.
@item
Include an unaltered copy of this License.
@item
Preserve the section Entitled ``History'', Preserve its Title, and add
to it an item stating at least the title, year, new authors, and
publisher of the Modified Version as given on the Title Page. If
there is no section Entitled ``History'' in the Document, create one
stating the title, year, authors, and publisher of the Document as
given on its Title Page, then add an item describing the Modified
Version as stated in the previous sentence.
@item
Preserve the network location, if any, given in the Document for
public access to a Transparent copy of the Document, and likewise
the network locations given in the Document for previous versions
it was based on. These may be placed in the ``History'' section.
You may omit a network location for a work that was published at
least four years before the Document itself, or if the original
publisher of the version it refers to gives permission.
@item
For any section Entitled ``Acknowledgements'' or ``Dedications'', Preserve
the Title of the section, and preserve in the section all the
substance and tone of each of the contributor acknowledgements and/or
dedications given therein.
@item
Preserve all the Invariant Sections of the Document,
unaltered in their text and in their titles. Section numbers
or the equivalent are not considered part of the section titles.
@item
Delete any section Entitled ``Endorsements''. Such a section
may not be included in the Modified Version.
@item
Do not retitle any existing section to be Entitled ``Endorsements'' or
to conflict in title with any Invariant Section.
@item
Preserve any Warranty Disclaimers.
@end enumerate
If the Modified Version includes new front-matter sections or
appendices that qualify as Secondary Sections and contain no material
copied from the Document, you may at your option designate some or all
of these sections as invariant. To do this, add their titles to the
list of Invariant Sections in the Modified Version's license notice.
These titles must be distinct from any other section titles.
You may add a section Entitled ``Endorsements'', provided it contains
nothing but endorsements of your Modified Version by various
parties---for example, statements of peer review or that the text has
been approved by an organization as the authoritative definition of a
standard.
You may add a passage of up to five words as a Front-Cover Text, and a
passage of up to 25 words as a Back-Cover Text, to the end of the list
of Cover Texts in the Modified Version. Only one passage of
Front-Cover Text and one of Back-Cover Text may be added by (or
through arrangements made by) any one entity. If the Document already
includes a cover text for the same cover, previously added by you or
by arrangement made by the same entity you are acting on behalf of,
you may not add another; but you may replace the old one, on explicit
permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License
give permission to use their names for publicity for or to assert or
imply endorsement of any Modified Version.
@item
COMBINING DOCUMENTS
You may combine the Document with other documents released under this
License, under the terms defined in section 4 above for modified
versions, provided that you include in the combination all of the
Invariant Sections of all of the original documents, unmodified, and
list them all as Invariant Sections of your combined work in its
license notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and
multiple identical Invariant Sections may be replaced with a single
copy. If there are multiple Invariant Sections with the same name but
different contents, make the title of each such section unique by
adding at the end of it, in parentheses, the name of the original
author or publisher of that section if known, or else a unique number.
Make the same adjustment to the section titles in the list of
Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled ``History''
in the various original documents, forming one section Entitled
``History''; likewise combine any sections Entitled ``Acknowledgements'',
and any sections Entitled ``Dedications''. You must delete all
sections Entitled ``Endorsements.''
@item
COLLECTIONS OF DOCUMENTS
You may make a collection consisting of the Document and other documents
released under this License, and replace the individual copies of this
License in the various documents with a single copy that is included in
the collection, provided that you follow the rules of this License for
verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute
it individually under this License, provided you insert a copy of this
License into the extracted document, and follow this License in all
other respects regarding verbatim copying of that document.
@item
AGGREGATION WITH INDEPENDENT WORKS
A compilation of the Document or its derivatives with other separate
and independent documents or works, in or on a volume of a storage or
distribution medium, is called an ``aggregate'' if the copyright
resulting from the compilation is not used to limit the legal rights
of the compilation's users beyond what the individual works permit.
When the Document is included in an aggregate, this License does not
apply to the other works in the aggregate which are not themselves
derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these
copies of the Document, then if the Document is less than one half of
the entire aggregate, the Document's Cover Texts may be placed on
covers that bracket the Document within the aggregate, or the
electronic equivalent of covers if the Document is in electronic form.
Otherwise they must appear on printed covers that bracket the whole
aggregate.
@item
TRANSLATION
Translation is considered a kind of modification, so you may
distribute translations of the Document under the terms of section 4.
Replacing Invariant Sections with translations requires special
permission from their copyright holders, but you may include
translations of some or all Invariant Sections in addition to the
original versions of these Invariant Sections. You may include a
translation of this License, and all the license notices in the
Document, and any Warranty Disclaimers, provided that you also include
the original English version of this License and the original versions
of those notices and disclaimers. In case of a disagreement between
the translation and the original version of this License or a notice
or disclaimer, the original version will prevail.
If a section in the Document is Entitled ``Acknowledgements'',
``Dedications'', or ``History'', the requirement (section 4) to Preserve
its Title (section 1) will typically require changing the actual
title.
@item
TERMINATION
You may not copy, modify, sublicense, or distribute the Document
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense, or distribute it is void, and
will automatically terminate your rights under this License.
However, if you cease all violation of this License, then your license
from a particular copyright holder is reinstated (a) provisionally,
unless and until the copyright holder explicitly and finally
terminates your license, and (b) permanently, if the copyright holder
fails to notify you of the violation by some reasonable means prior to
60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, receipt of a copy of some or all of the same material does
not give you any rights to use it.
@item
FUTURE REVISIONS OF THIS LICENSE
The Free Software Foundation may publish new, revised versions
of the GNU Free Documentation License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns. See
@uref{http://www.gnu.org/copyleft/}.
Each version of the License is given a distinguishing version number.
If the Document specifies that a particular numbered version of this
License ``or any later version'' applies to it, you have the option of
following the terms and conditions either of that specified version or
of any later version that has been published (not as a draft) by the
Free Software Foundation. If the Document does not specify a version
number of this License, you may choose any version ever published (not
as a draft) by the Free Software Foundation. If the Document
specifies that a proxy can decide which future versions of this
License can be used, that proxy's public statement of acceptance of a
version permanently authorizes you to choose that version for the
Document.
@item
RELICENSING
``Massive Multiauthor Collaboration Site'' (or ``MMC Site'') means any
World Wide Web server that publishes copyrightable works and also
provides prominent facilities for anybody to edit those works. A
public wiki that anybody can edit is an example of such a server. A
``Massive Multiauthor Collaboration'' (or ``MMC'') contained in the
site means any set of copyrightable works thus published on the MMC
site.
``CC-BY-SA'' means the Creative Commons Attribution-Share Alike 3.0
license published by Creative Commons Corporation, a not-for-profit
corporation with a principal place of business in San Francisco,
California, as well as future copyleft versions of that license
published by that same organization.
``Incorporate'' means to publish or republish a Document, in whole or
in part, as part of another Document.
An MMC is ``eligible for relicensing'' if it is licensed under this
License, and if all works that were first published under this License
somewhere other than this MMC, and subsequently incorporated in whole
or in part into the MMC, (1) had no cover texts or invariant sections,
and (2) were thus incorporated prior to November 1, 2008.
The operator of an MMC Site may republish an MMC contained in the site
under CC-BY-SA on the same site at any time before August 1, 2009,
provided the MMC is eligible for relicensing.
@end enumerate
@page
@heading ADDENDUM: How to use this License for your documents
To use this License in a document you have written, include a copy of
the License in the document and put the following copyright and
license notices just after the title page:
@smallexample
@group
Copyright (C) @var{year} @var{your name}.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
Texts. A copy of the license is included in the section entitled ``GNU
Free Documentation License''.
@end group
@end smallexample
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
replace the ``with@dots{}Texts.''@: line with this:
@smallexample
@group
with the Invariant Sections being @var{list their titles}, with
the Front-Cover Texts being @var{list}, and with the Back-Cover Texts
being @var{list}.
@end group
@end smallexample
If you have Invariant Sections without Cover Texts, or some other
combination of the three, merge those two alternatives to suit the
situation.
If your document contains nontrivial examples of program code, we
recommend releasing these examples in parallel under your choice of
free software license, such as the GNU General Public License,
to permit their use in free software.
@c Local Variables:
@c ispell-local-pdict: "ispell-dict"
@c End:

188
doc/hypo.texi
View file

@ -1,188 +0,0 @@
\input texinfo @c -*-texinfo-*-
@c %**start of header
@setfilename hypo.info
@settitle Hypo user manual
@c %**end of header
@copying
How to use hypo.
Copyright @copyright{} 2013 Tom Willemse
@quotation
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled ``GNU
Free Documentation License''.
A copy of the license is also available from the Free Software
Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
@end quotation
The document was typeset with
@uref{http://www.texinfo.org/, GNU Texinfo}.
@end copying
@titlepage
@title Hypo user manual
@subtitle How to use hypo
@author Tom Willemse <tom@@ryuslash.org>
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage
@c Output the table of the contents at the beginning.
@contents
@ifnottex
@node Top, Introduction, (dir), (dir)
@top Hypo user manual
@insertcopying
@end ifnottex
@c Generate the nodes for this menu with `C-c C-u C-m'.
@menu
* Introduction:: Meet Hypo
* Usage:: What you can do with hypo
* Clients::
* Copying This Manual::
* Index::
@end menu
@c Update all node entries with `C-c C-u C-n'.
@c Insert new nodes with `C-c C-c n'.
@node Introduction, Usage, Top, Top
@chapter Introduction to Hypo
Hypo comes from a desire to share snippets, screenshots and the like
with friends and colleagues the easiest and fastest way possible.
@menu
* Features:: What hypo can do
@end menu
@node Features, , Introduction, Introduction
@section Features
Hypo offers a small, but useful number of features.
@itemize
@item
Easy sharing and maintenance of files, snippets or screenshots using
familiar HTTP verbs such as @samp{POST}, @samp{GET} and @samp{DELETE}.
@item
Syntax highlighting with @uref{http://pygments.org/, pygments}.
@item
Separate HTML, raw or download views.
@end itemize
@node Usage, Clients, Introduction, Top
@chapter Using hypo
Hypo is used through a very simple web API that uses normal, everyday
HTTP methods to manipulate files.
@menu
* Uploading:: Getting new files in hypo
* Viewing:: Viewing the files in hypo
* Deleting:: Removing old files from hypo
@end menu
@node Uploading, Viewing, Usage, Usage
@section Uploading files
Uploading is done with the @samp{PUT} HTTP method. An example with
curl:
@example
# curl --upload-file README.org http://yourserver.example.com/ 2>/dev/null
http://yourserver.example.com/abcdef1
@end example
After uploading a file to the server it will respond with the url of
your newly uploaded file. If you browse to this URL using your
favorite browser you will find a page showing the file. For text files
it will try to provide some syntax highlighting, for certain types of
images (currently @samp{jpg}, @samp{png} and @samp{gif}) it will show
the image.
If Hypo doesn't know what kind of file you're uploading it will
default to treating it as a text file.
@node Viewing, Deleting, Uploading, Usage
@section Viewing uploaded files
All files can be viewed (from, for example, your web browser) in three
different ways. The regularly, raw and as download.
The regular way sshows a web page with the file either syntax
highlighted using @samp{pygments} or (in case it is an image) with the
image shown on the page. This is viewed using the URL printed after
upload has completed. For example:
@example
http://yourserver.example.com/abcdef1
@end example
The raw view is just the file, saving this file is the same as
downloading it. This is viewed by prefixing the last part of the URL
with @samp{raw/}. For example:
@example
http://yourserver.example.com/raw/abcdef1
@end example
The download view is the same as the raw view except that the
@samp{Content-Disposition} header has been set to @samp{attachment}.
This causes a download dialog to show up instead of your browser
trying to render it. This is viewed by prefixing the last part of the
URL with @samp{dl/}. For example:
@example
http://yourserver.example.com/dl/abcdef1
@end example
@node Deleting, , Viewing, Usage
@section Deleting uploaded files
After you have uploaded a file you can delete it again by using the
@samp{DELETE} HTTP method. An example with curl:
@example
# curl -XDELETE http://yourserver.example.com/abcdef1
Succesfully removed abcdef1
@end example
There is currently no way to authenticate yourself with the server,
so anyone can delete (also post) files. Of course they would first
have to know the URL to send the delete to.
@node Clients, Copying This Manual, Usage, Top
@chapter Client programs
Hypo tries to stay simple to work with, at least on the client-side.
However, some clients may make things even easier. Currently there is
the (incomplete) @uref{http://code.ryuslash.org/hypo-emacs/about/,
Emacs client} and also a
@uref{http://code.ryuslash.org/hypo-cli/about/, simple CLI client}.
@node Copying This Manual, Index, Clients, Top
@appendix Copying This Manual
@include fdl.texi
@node Index, , Copying This Manual, Top
@unnumbered Index
@printindex cp
@bye
@c hypo.texi ends here

163
hypo.hy
View file

@ -15,12 +15,11 @@
;; You should have received a copy of the GNU Affero General Public ;; You should have received a copy of the GNU Affero General Public
;; License along with Hypo. If not, see <http://www.gnu.org/licenses/>. ;; License along with Hypo. If not, see <http://www.gnu.org/licenses/>.
(import web sys os hashlib datetime shutil (import web sys os hashlib datetime
[pygments [highlight]] [pygments [highlight]]
[pygments.lexers [get-lexer-by-name guess-lexer-for-filename]] [pygments.lexers [get-lexer-by-name guess-lexer-for-filename]]
[pygments.formatters [HtmlFormatter]] [pygments.formatters [HtmlFormatter]]
[pygments.util [ClassNotFound]] [pygments.util [ClassNotFound]])
[gittle [Gittle]])
(try (import [config [*]]) (try (import [config [*]])
(catch [ImportError] (catch [ImportError]
@ -29,11 +28,13 @@
(sys.exit 1))) (sys.exit 1)))
(def render (web.template.render "templates/")) (def render (web.template.render "templates/"))
(def urls (, (+ "/" *prefix*) "index" (def urls (, (+ "/" *prefix* "raw/(.*)") "raw"
(+ "/" *prefix* "raw/(.*)") "raw"
(+ "/" *prefix* "dl/(.*)") "download" (+ "/" *prefix* "dl/(.*)") "download"
(+ "/" *prefix* "([a-f0-9]{7})$") "html" (+ "/" *prefix* "([a-f0-9]{7})$") "html"
(+ "/" *prefix* "(.*)") "upload")) (+ "/" *prefix* "(.*)") "upload"))
(def db
(kwapply (web.database)
{"dbn" "postgres" "user" *dbuser* "pw" *dbpw* "db" *dbname*}))
(defun hashes [name] (defun hashes [name]
(let ((hasher (hashlib.sha1))) (let ((hasher (hashlib.sha1)))
@ -44,18 +45,23 @@
(defun get-type [ext] (defun get-type [ext]
(cond (cond
[(in ext (, ".jpg" ".jpeg" ".png" ".gif")) "image"] ((in ext (, ".jpg" ".jpeg" ".png" ".gif")) "image")
[True "text"])) (true "text")))
(defun read-file [filename] (defun read-file [filename]
(let (res) (let (res)
(with [[f (file filename "r")]] (with [f (file filename "r")]
(setv res (f.read))) (setv res (f.read)))
res)) res))
(defun no-such-file [] (defun no-such-file []
(setv web.ctx.status (str "404 Not Found")) (setv web.ctx.status (str "404 Not Found"))
(render.notfound)) "No such file.\n")
(defun get-file [name]
(let ((res (kwapply (db.select "hfile" {"shash" name})
{"where" "shash = $shash"})))
(if res (car res))))
(defun get-lexer [filename content] (defun get-lexer [filename content]
"Try to guess the correct lexer by FILENAME and CONTENT. "Try to guess the correct lexer by FILENAME and CONTENT.
@ -65,94 +71,73 @@ If no lexer is found fallback onto the text lexer."
(catch [ClassNotFound] (catch [ClassNotFound]
(get-lexer-by-name "text")))) (get-lexer-by-name "text"))))
(defun get-raw [self name]
(let ((dirname (+ "files/" (os.path.dirname name)))
(repo (and (os.path.exists dirname)
(Gittle dirname)))
(resp (if repo
(get (.commit-file repo "HEAD" (os.path.basename name))
"data"))))
(or resp (no-such-file))))
(defun get-attachment [self name]
(let ((dirname (+ "files/" (os.path.dirname name)))
(repo (and (os.path.exists dirname)
(Gittle dirname))))
(if repo
(progn
(web.header "Content-Disposition"
(+ "attachment; filename=\"" name "\""))
(get (.commit-file repo "HEAD" (os.path.basename name)) "data"))
(no-such-file))))
(defun render-file [hash repo ref filename]
(if (not (os.path.isdir filename))
(let ((content (get (.commit-file repo ref filename) "data"))
(lexer (get-lexer filename content))
(formatter (HtmlFormatter))
(kwargs {"file" filename "hash" hash}))
(.update
kwargs (if (in (get (os.path.splitext filename) 1)
[".png" ".jpg" ".jpeg" ".gif"])
{"content" (apply render.image []
{"name" filename
"hash" hash})
"style" ""}
{"content" (highlight content lexer formatter)
"style" (formatter.get-style-defs ".highlight")}))
(apply render.main [] kwargs))
""))
(defun get-html [self name]
(let ((dirname (+ "files/" name))
(repo (and (os.path.exists dirname)
(Gittle dirname))))
(if repo
(car (list-comp (render-file name repo "HEAD" f)
[f (.iterkeys (.commit-tree repo "HEAD"))]
(not (or (= f ".")
(= f "..")))))
(no-such-file))))
(defun delete-dir [self name]
(let ((dirname (+ "files/" name)))
(if (os.path.exists dirname)
(do (shutil.rmtree dirname)
(+ "Successfully removed " name "\n"))
(no-such-file))))
(defun upload-file [self name]
(let ((h (hashes name))
(dirname (+ "files/" (get h 0))))
(os.mkdir dirname)
(with [[f (file (+ dirname "/" name) "w")]]
(.write f (web.data)))
(let ((repo (Gittle.init dirname)))
(.stage repo [(str name)])
(apply repo.commit []
{"name" "Hypo"
"email" "hypo@ryuslash.org"
"message" "Initial commit"}))
(setv web.ctx.status (str "201 Created"))
(+ web.ctx.home "/" *prefix* (get h 0) "\n")))
(defclass raw [] (defclass raw []
[[GET get-raw]]) [[GET (lambda [self name]
(let ((filename (+ "files/" name))
(resp (if (os.path.exists filename)
(read-file filename))))
(or resp (no-such-file))))]])
(defclass download [] (defclass download []
[[GET get-attachment]]) [[GET (lambda [self name]
(let ((hfile (get-file name))
(filename (+ "files/" name)))
(if (and hfile (os.path.exists filename))
(progn
(web.header "Content-Disposition"
(+ "attachment; filename=\""
hfile.filename "\""))
(read-file filename))
(no-such-file))))]])
(defclass html [] (defclass html []
[[GET get-html] [[GET (lambda [self name]
[DELETE delete-dir]]) (let ((hfile (get-file name))
(filename (+ "files/" name)))
(if (and hfile (os.path.exists filename))
(cond
((= hfile.type "text")
(progn
(let ((content (read-file filename))
(lexer (get-lexer hfile.filename content))
(formatter (HtmlFormatter)))
(kwapply (render.main)
{"content" (highlight content lexer
formatter)
"style" (formatter.get-style-defs
".highlight")
"file" hfile})
)))
((= hfile.type "image")
(kwapply (render.main)
{"content" (kwapply (render.image)
{"name" name})
"style" ""
"file" hfile})))
(no-such-file))))]
[DELETE (lambda [self name]
(let ((filename (+ "files/" name)))
(kwapply (db.delete "hfile")
{"where" (+ "shash = '" name "'")})
(if (os.path.exists filename)
(os.remove filename)
(no-such-file))))]])
(defclass upload [] (defclass upload []
[[PUT upload-file]]) [[PUT (lambda [self name]
(let ((h (hashes name)))
(defclass index [] (with [f (file (+ "files/" (get h 0)) "w")]
[[GET (lambda [self] (render.index))]]) (.write f (web.data)))
(kwapply (db.insert "hfile")
{"shash" (get h 0)
"hash" (get h 1)
"filename" name
"type" (get-type (get (os.path.splitext name) 1))})
(setv web.ctx.status (str "201 Created"))
(+ web.ctx.home "/" *prefix* (get h 0) "\n")))]])
(defun hypo-start [argv] (defun hypo-start [argv]
(let ((sys.argv argv) (let ((sys.argv (cdr sys.argv))
(app (web.application urls (globals)))) (app (web.application urls (globals))))
(.run app))) (.run app)))

31
hypoctl
View file

@ -18,21 +18,38 @@
(import pycommand sys web os (import pycommand sys web os
[hypo [hypo-start]]) [hypo [hypo-start]])
(try (import [config [*]])
(catch [ImportError]
(print "Please copy the config.example.hy to config.hy and set"
"the values to your preference.")
(sys.exit 1)))
(def db
(kwapply (web.database)
{"dbn" "postgres" "user" *dbuser* "pw" *dbpw* "db" *dbname*}))
(defun hypo-purge [argv]
(db.delete "hfile" "TRUE")
(foreach [f (os.listdir "files/")]
(os.remove (os.path.join "files" f))))
(defclass hypoctl-command (pycommand.CommandBase) (defclass hypoctl-command (pycommand.CommandBase)
[[usagestr "usage: hypoctl <command> [<args]"] [[usagestr "usage: hypoctl <command> [<args]"]
[description "Control hypo"] [description "Control hypo"]
[run (lambda [self] [run (lambda [self]
(cond (cond
[(not self.args) ((not self.args)
(progn (print self.usage) 2)] (progn (print self.usage) 2))
[(= (car self.args) "start") ((= (car self.args) "purge")
(hypo-start (cdr self.args))] (hypo-purge (cdr self.args)))
[True ((= (car self.args) "start")
(hypo-start (cdr self.args)))
(True
(print (.format "error: command {0} does not exist" (print (.format "error: command {0} does not exist"
(car self.args)))]))]]) (car self.args))))))]])
(when (= __name__ "__main__") (when (= __name__ "__main__")
(let ((cmd (hypoctl-command (cdr sys.argv)))) (let ((cmd (hypoctl-command (cdr (cdr sys.argv)))))
(if cmd.error (if cmd.error
(progn (print (.format "error: {0}" cmd.error)) (progn (print (.format "error: {0}" cmd.error))
(sys.exit 1)) (sys.exit 1))

5
requirements.txt
View file

@ -1,5 +0,0 @@
hy==0.10.0
gittle==0.2.2
pycommand==0.1.0
web.py==0.37
Pygments==1.6

6
templates/image.html
View file

@ -1,4 +1,4 @@
$def with (name, hash) $def with (name)
$# Hypo -- Quickly share stuff $# Hypo -- Quickly share stuff
$# Copyright (C) 2013 Tom Willemse $# Copyright (C) 2013 Tom Willemse
$# $#
@ -15,6 +15,6 @@ $#
$# You should have received a copy of the GNU Affero General Public $# You should have received a copy of the GNU Affero General Public
$# License along with Hypo. If not, see <http://www.gnu.org/licenses/>. $# License along with Hypo. If not, see <http://www.gnu.org/licenses/>.
<a href="raw/$hash/$name"> <a href="raw/$name">
<img src="raw/$hash/$name" alt="$name"> <img src="raw/$name" alt="$name">
</a> </a>

160
templates/index.html
View file

@ -1,160 +0,0 @@
$# Hypo -- Quickly share stuff
$# Copyright (C) 2013 Tom Willemse
$#
$# Hypo is free software: you can redistribute it and/or modify it
$# under the terms of the GNU Affero General Public License as
$# published by the Free Software Foundation, either version 3 of the
$# License, or (at your option) any later version.
$#
$# Hypo 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 Affero General
$# Public License for more details.
$#
$# You should have received a copy of the GNU Affero General Public
$# License along with Hypo. If not, see <http://www.gnu.org/licenses/>.
<!DOCTYPE html>
<html>
<head>
<title>Hypo</title>
<link href="//cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/2.3.2/css/bootstrap.min.css"
type="text/css" rel="stylesheet" />
<meta name="robots" content="noindex, nofollow">
</head>
<body>
<div class="navbar navbar-static-top navbar-inverse">
<div class="navbar-inner">
<a class="brand">Hypo</a>
</div>
</div>
<div class="container">
<h1>Hypo</h1>
<p>
This is hypo. Hypo is supposed to be an easy way to share/store
code snippets and other files.
</p>
<div id="outline-container-sec-1-1" class="outline-3">
<h2 id="sec-1">Usage</h2>
<div class="outline-text-2" id="text-1">
<p>
Once setup it will not show much of anything, first you'll
have to upload something.
</p>
</div>
<div id="outline-container-sec-1-1" class="outline-3">
<h3 id="sec-1-1">Uploading</h3>
<div class="outline-text-3" id="text-1-1">
<p>
Uploading is done with the <code>PUT</code> HTTP method.
An example with curl:
</p>
<pre class="example"># curl --upload-file README.org http://yourserver.example.com/ 2&gt;/dev/null
http://yourserver.example.com/abcdef1</pre>
<p>
After uploading a file to the server it will respond
with the url of your newly uploaded file. If you browse
to this URL using your favorite browser you will find a
page showing the file. For text files it will try to
provide some syntax highlighting, for certain types of
images (currently <code>jpg</code>, <code>png</code>
and <code>gif</code>) it will show the image.
</p>
<p>
If Hypo doens't know what kind of file you're uploading
it will default to treating it as a text file.
</p>
</div>
</div>
<div id="outline-container-sec-1-2" class="outline-3">
<h3 id="sec-1-2">Viewing</h3>
<div class="outline-text-3" id="text-1-2">
<p>
All files can be viewed (from, for example, your web
browser) in three different ways. The regularly, raw and
as download.
</p>
<p>
The regular way shows a web page with the file either
syntax highlighted using <code>pygments</code> or (in
case it is an image) with the image shown on the page.
This is viewed by using the URL printed after upload has
completed. For example:
</p>
<pre class="example">http://yourserver.example.com/abcdef1</pre>
<p>
The raw view is just the file, saving this file is the
same as downloading it. This is viewed by prefixing the
last part of the URL with <code>raw/</code>. For
example:
</p>
<pre class="example">http://yourserver.example.com/raw/abcdef1</pre>
<p>
The download view is the same as the raw view except
that the <code>Content-Disposition</code> header has
been set to <code>attachment</code>. This causes a
download dialog to show up instead of your browser
trying to render it. This is viewed by prefixing the
last part of the URL with <code>dl/</code>. For example:
</p>
<pre class="example">http://yourserver.example.com/dl/abcdef1</pre>
</div>
</div>
<div id="outline-container-sec-1-3" class="outline-3">
<h3 id="sec-1-3">Deleting</h3>
<div class="outline-text-3" id="text-1-3">
<p>
After you have uploaded a file you can delete it again
by using the <code>DELETE</code> HTTP method. An example
with curl:
</p>
<pre class="example"># curl -XDELETE http://yourserver.example.com/abcdef1
Successfully removed abcdef1</pre>
<p>
There is currently no way to authenticate yourself with
the server, so anyone can delete (also post) files. Of
course they would first have to know the URL to send the
delete to.
</p>
</div>
</div>
</div>
<div id="outline-container-sec-2" class="outline-2">
<h2 id="sec-2">Clients</h2>
<div class="outline-text-2" id="text-2">
<p>
Hypo tries to stay simple to work with, at least on the
client-side. However, some clients may make things easier.
Currently there is only the
(incomplete) <a href="http://code.ryuslash.org/hypo-emacs/">Emacs
client</a> and a simple
<a href="http://code.ryuslash.org/hypo-cli/">CLI client</a>.
</p>
</div>
</div>
<footer>
This site is powered
by <a href="http://projects.ryuslash.org/hypo">Hypo</a>. Hypo
is available under
the <a href="https://www.gnu.org/licenses/agpl-3.0.html">GNU
Affero General Public License</a>. You can download its source
code <a href="http://code.ryuslash.org/cgit.cgi/hypo/">here</a>.
</footer>
</div>
</body>
</html>

14
templates/main.html
View file

@ -1,4 +1,4 @@
$def with (content, style, file, hash) $def with (content, style, file)
$# Hypo -- Quickly share stuff $# Hypo -- Quickly share stuff
$# Copyright (C) 2013 Tom Willemse $# Copyright (C) 2013 Tom Willemse
$# $#
@ -17,7 +17,7 @@ $# License along with Hypo. If not, see <http://www.gnu.org/licenses/>.
<!DOCTYPE html> <!DOCTYPE html>
<html> <html>
<head> <head>
<title>Hypo: $file</title> <title>Hypo: $file.filename</title>
<link href="//cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/2.3.2/css/bootstrap.min.css" <link href="//cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/2.3.2/css/bootstrap.min.css"
type="text/css" rel="stylesheet" /> type="text/css" rel="stylesheet" />
<style>$:style</style> <style>$:style</style>
@ -27,15 +27,15 @@ $# License along with Hypo. If not, see <http://www.gnu.org/licenses/>.
<div class="navbar navbar-static-top navbar-inverse"> <div class="navbar navbar-static-top navbar-inverse">
<div class="navbar-inner"> <div class="navbar-inner">
<a class="brand">Hypo</a> <a class="brand">Hypo</a>
<ul class="nav">
<li><a href="raw/$file.shash">Raw</a></li>
<li><a href="dl/$file.shash">Download</a></li>
</ul>
</div> </div>
</div> </div>
<div class="container"> <div class="container">
<h1> <h1>$file.filename</h1>
$file
<a href="raw/$hash/$file"><i class="icon-file"></i></a>
<a href="dl/$hash/$file"><i class="icon-download"></i></a>
</h1>
<div class="row">$:content</div> <div class="row">$:content</div>

48
templates/notfound.html
View file

@ -1,48 +0,0 @@
$# Hypo -- Quickly share stuff
$# Copyright (C) 2013 Tom Willemse
$#
$# Hypo is free software: you can redistribute it and/or modify it
$# under the terms of the GNU Affero General Public License as
$# published by the Free Software Foundation, either version 3 of the
$# License, or (at your option) any later version.
$#
$# Hypo 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 Affero General
$# Public License for more details.
$#
$# You should have received a copy of the GNU Affero General Public
$# License along with Hypo. If not, see <http://www.gnu.org/licenses/>.
<!DOCTYPE html>
<html>
<head>
<title>Hypo: Not Found</title>
<link href="//cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/2.3.2/css/bootstrap.min.css"
type="text/css" rel="stylesheet" />
<meta name="robots" content="noindex, nofollow">
</head>
<body>
<div class="navbar navbar-static-top navbar-inverse">
<div class="navbar-inner">
<a class="brand">Hypo</a>
</div>
</div>
<div class="container">
<h1>No such file</h1>
<div class="alert alert-error">
The file you are looking for could not be found.
</div>
<footer>
This site is powered
by <a href="http://projects.ryuslash.org/hypo">Hypo</a>. Hypo is
available under
the <a href="https://www.gnu.org/licenses/agpl-3.0.html">GNU
Affero General Public License</a>. You can download its source
code <a href="http://code.ryuslash.org/cgit.cgi/hypo/">here</a>.
</footer>
</div>
</body>
</html>

49
upgrade-git.hy
View file

@ -1,49 +0,0 @@
#!/usr/bin/env hy
;; Hypo -- Quickly share stuff
;; Copyright (C) 2013 Tom Willemse
;; Hypo is free software: you can redistribute it and/or modify it
;; under the terms of the GNU Affero General Public License as
;; published by the Free Software Foundation, either version 3 of the
;; License, or (at your option) any later version.
;; Hypo 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 Affero General
;; Public License for more details.
;; You should have received a copy of the GNU Affero General Public
;; License along with Hypo. If not, see <http://www.gnu.org/licenses/>.
(import web os
[gittle [Gittle]])
(try (import [config [*]])
(catch [ImportError]
(print "Please copy the config.example.hy to config.hy and set"
"the values to your preference.")
(sys.exit 1)))
(def db
(apply web.database []
{"dbn" "postgres" "user" *dbuser* "pw" *dbpw* "db" *dbname*}))
(defun get-file [name]
(let ((res (apply .select
[db "hfile" {"shash" name}]
{"where" "shash = $shash"})))
(if res (car res))))
(foreach [f (os.listdir "files/")]
(let ((file (get-file f)))
(os.rename (+ "files/" f)
(+ "files/" file.filename))
(os.mkdir (+ "files/" f))
(os.rename (+ "files/" file.filename)
(+ "files/" f "/" file.filename))
(let ((repo (Gittle.init (+ "files/" f))))
(.stage repo [(str file.filename)])
(apply repo.commit []
{"name" "System"
"email" "tom@ryuslash.org"
"message" "Initial commit for upgrade to git"}))))