├── config.mk ├── test.xml ├── global.h ├── xmlhelpers.h ├── Makefile ├── test.sh ├── dist └── archlinux │ └── PKGBUILD ├── README.md ├── xmlhelpers.c ├── main.c └── LICENSE /config.mk: -------------------------------------------------------------------------------- 1 | PREFIX = /usr 2 | MANPREFIX = /${PREFIX}/share/man 3 | -------------------------------------------------------------------------------- /test.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | some text 6 | 7 | -------------------------------------------------------------------------------- /global.h: -------------------------------------------------------------------------------- 1 | /* Useful definitions used throughout xmlfs */ 2 | 3 | #ifndef __GLOBAL_H_INCLUDED__ 4 | #define __GLOBAL_H_INCLUDED__ 5 | 6 | #define INDEX_BASE 1 7 | #define CONTENT_FILENAME "#text" 8 | 9 | /* Macro to make compilers not warn about unused parameters 10 | * http://sourcefrog.net/weblog/software/languages/C/unused.html */ 11 | #ifdef UNUSED 12 | #elif defined(__GNUC__) 13 | # define UNUSED(x) UNUSED_ ## x __attribute__((unused)) 14 | #elif defined(__LCLINT__) 15 | # define UNUSED(x) /*@unused@*/ x 16 | #else 17 | # define UNUSED(x) x 18 | #endif 19 | 20 | #endif 21 | -------------------------------------------------------------------------------- /xmlhelpers.h: -------------------------------------------------------------------------------- 1 | /* 2 | * Part of xmlfs 3 | * Released under GPL 2 - see LICENSE for details. 4 | * Very early version. 5 | * 6 | * Copyright (c) 2009 Henrik Hallberg 7 | * Please report bugs of feature requests by email 8 | * 9 | * http://github.com/halhen/xmlfs 10 | */ 11 | 12 | #ifndef __XMLHELPERS_H_INCLUDED__ 13 | #define __XMLHELPERS_H_INCLUDED__ 14 | 15 | #include 16 | 17 | char* node_value(xmlElement* xel); 18 | void count_twins(xmlElement* el, int *twins_before, int *twins_total); 19 | xmlElement* findxmlelement(const char *path, xmlNode *root); 20 | int has_content(xmlNode* node); 21 | 22 | #endif 23 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | include config.mk 2 | 3 | CC = gcc 4 | CFLAGS = -O2 -Wall -W 5 | OBJECTS = main.o xmlhelpers.o 6 | 7 | all: $(OBJECTS) 8 | $(CC) `pkg-config --libs fuse` `xml2-config --libs` $(OBJECTS) -o xmlfs -g 9 | 10 | %.o: %.c 11 | $(CC) $(CFLAGS) `pkg-config --cflags fuse` `xml2-config --cflags` -c $< 12 | 13 | clean: 14 | rm xmlfs $(OBJECTS) 15 | 16 | install: all 17 | @echo installing executable to ${DESTDIR}${PREFIX}/bin 18 | @mkdir -p ${DESTDIR}${PREFIX}/bin 19 | @cp -f xmlfs ${DESTDIR}${PREFIX}/bin 20 | @chmod 755 ${DESTDIR}${PREFIX}/bin/xmlfs 21 | 22 | uninstall: 23 | @echo removing executable from ${DESTDIR}${PREFIX}/bin 24 | @rm ${DESTDIR}${PREFIX}/bin/xmlfs 25 | -------------------------------------------------------------------------------- /test.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | 4 | # Mount filesystem 5 | mkdir -p mnt/ 6 | ./xmlfs mnt/ -o xmlfile=test.xml 7 | 8 | # Do basic tests 9 | cd mnt/ 10 | if [ `find 1.root/ -name '*.node' | wc -l` -ne 2 ]; then 11 | echo "Too many %d.nodes in 1.root"; 12 | fi 13 | 14 | if [ `find 1.root/1.node/ -name 'attribute' | wc -l` -ne 1 ]; then 15 | echo "attribute error in 1.root/1.node/"; 16 | fi 17 | if [ `find 1.root/1.node/ -name 'attribute2' | wc -l` -ne 0 ]; then 18 | echo "attribute2 should not be in 1.root/1.node"; 19 | fi 20 | if [ `cat 1.root/1.node/attribute` != "attrib_value" ]; then 21 | echo "1.root/1.node/attribute does not contain 'attrib_value'"; 22 | fi 23 | 24 | if [ `find 1.root/2.node/ -name 'attribute' | wc -l` -ne 0 ]; then 25 | echo "attribute should not be in 1.root/1.node/"; 26 | fi 27 | if [ `find 1.root/2.node/ -name 'attribute2' | wc -l` -ne 1 ]; then 28 | echo "attribute2 error in 1.root/1.node"; 29 | fi 30 | 31 | if [ "`cat 1.root/1.textcontent/#text`" != "some text" ]; then 32 | echo "Failed to read 1.root/1.textcontent/#text properly"; 33 | fi 34 | 35 | cd .. 36 | fusermount -u mnt 37 | echo "Done" 38 | -------------------------------------------------------------------------------- /dist/archlinux/PKGBUILD: -------------------------------------------------------------------------------- 1 | # PKGBUILD for ArchLinux 2 | # Uses the main git repository as source 3 | # Not using _gitroot and _gitname, since this PKGBUILD 4 | # is for installing tagged and released versions, 5 | # not the latest release. 6 | # Contributor: halhen 7 | 8 | pkgname=xmlfs 9 | pkgver=0.1.1 10 | pkgrel=1 11 | pkgdesc="mount xml files as directory structures" 12 | license=(GPL) 13 | arch=('i686' 'x86_64') 14 | url=http://github.com/halhen/xmlfs 15 | depends=('fuse>=2.6' libxml2) 16 | makedepends=(git) 17 | source=() 18 | 19 | build() { 20 | cd "$srcdir" 21 | msg "Connecting to git server..." 22 | 23 | if [[ -d "$srcdir/$pkgname" ]]; then 24 | (cd "$pkgname" && git pull origin master) || return 1 25 | msg "Repository updated" 26 | else 27 | git clone "http://github.com/halhen/xmlfs.git" || return 1 28 | msg "Repository cloned" 29 | fi 30 | 31 | rm -rf "$srcdir/$pkgname-build" 32 | cp -R "$srcdir/$pkgname"{,"-build"} 33 | cd "$srcdir/$pkgname-build" 34 | 35 | msg "Using version $pkgver..." 36 | git checkout $pkgver || return 1 37 | 38 | msg "Starting make ..." 39 | make PREFIX=/usr MANPREFIX=/usr/man DESTDIR=$startdir/pkg install || return 1 40 | install -D -m644 LICENSE $startdir/pkg/usr/share/licenses/$pkgname/LICENSE 41 | } 42 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # xmlfs 2 | xmlfs is an userspace application that lets you represent an XML file as a directory structure for easy access. In this early version, xmlfs only supports read operations. This may be extended in the future. 3 | 4 | * [source repository](http://github.com/halhen/xmlfs) 5 | 6 | Distribution specific links: 7 | 8 | * [archlinux AUR package](http://aur.archlinux.org/packages.php?ID=25905) 9 | 10 | ## Representation 11 | * Nodes are represented as directories. 12 | * Node attributes are represented as files, named as the attribute and contiaining the value. 13 | * Node content is available in the `#text` file. 14 | 15 | An example XML file and the corresponding directory structure is shown below. 16 | 17 | 18 | 19 | 20 | 21 | some text 22 | 23 | 24 | Example operations: 25 | 26 | $ tree 27 | . 28 | `-- 1.root 29 | |-- 1.node 30 | | `-- attribute 31 | |-- 1.other 32 | | `-- attribute 33 | |-- 1.textcontent 34 | | `-- #text 35 | |-- 2.node 36 | | `-- attribute2 37 | `-- rattr 38 | 39 | $ cat 1.root/2.node/attribute2 40 | second node 41 | 42 | $ cat 1.root/1.textcontent/#text 43 | some text 44 | 45 | As you can see in the example, node names are prefix with an index. This is nescessary as an XML node can have many children with the same name. 46 | 47 | ## Installation 48 | xmlfs depends on [FUSE 2.6+](http://fuse.sourceforge.net/) and [libxml2](http://www.xmlsoft.org/). Please install this before building xmlfs. 49 | 50 | Edit `config.mk` to match your setup. Next run 51 | 52 | $ make 53 | 54 | Finally, as root: 55 | 56 | # make install 57 | 58 | To uninstall, as root: 59 | 60 | # make uninstall 61 | 62 | ## Usage 63 | $ mkdir mount_dir/ 64 | $ xmlfs -o xmlfile=file.xml mount_dir/ 65 | 66 | Unmount with 67 | $ fusermount -u mount_dir 68 | 69 | Fore more information, please run `xmlfs --help` or have a look at the [FUSE wiki](http://apps.sourceforge.net/mediawiki/fuse/index.php?title=Main_Page). 70 | 71 | ## Limitations 72 | In this early version, xmlfs is a read-only filesystem. Also, it only reads basic XML and usage with non-ASCII characters has not been tested. 73 | 74 | ### Known errors: 75 | 76 | * valgrind reports false free()'s from using xml_rootparent 77 | 78 | ## License 79 | Copyright (c) 2009 Henrik Hallberg . Released under GPL 2, see LICENSE for details. Please report bugs or feature requests by email or at github. 80 | -------------------------------------------------------------------------------- /xmlhelpers.c: -------------------------------------------------------------------------------- 1 | /* 2 | * Part of xmlfs 3 | * Released under GPL 2 - see LICENSE for details. 4 | * Very early version. 5 | * 6 | * Copyright (c) 2009 Henrik Hallberg 7 | * Please report bugs of feature requests by email 8 | * 9 | * http://github.com/halhen/xmlfs 10 | */ 11 | 12 | #include 13 | 14 | #include "global.h" 15 | #include "xmlhelpers.h" 16 | 17 | xmlElement* _findxmlelement(const char* path, xmlNode* parent) 18 | /* Recursively search parent for path. First try nodes, 19 | * then try attributes */ 20 | { 21 | size_t len; 22 | xmlNode *node = NULL; 23 | xmlAttr *attr = NULL; 24 | 25 | int counter; 26 | int index = INDEX_BASE; 27 | 28 | if (!path || !parent) 29 | return (xmlElement*)parent; 30 | 31 | if (*path == '/') 32 | path++; 33 | if (*path == '\0') 34 | return (xmlElement*)parent; 35 | 36 | if (sscanf(path, "%d.", &index) == 1) { 37 | /* An indexed object. Set path to actual name */ 38 | path = strstr(path, ".") + 1; 39 | } 40 | 41 | /* Search nodes - which are indexed */ 42 | for (node = parent->children, counter = INDEX_BASE; node; node = node->next) { 43 | len = strlen((char*)node->name); 44 | if (strncmp((char*)node->name, path, len) == 0 && 45 | (path[len] == '/' || path[len] == '\0')) { 46 | if (counter == index) 47 | break; 48 | counter += 1; 49 | } 50 | } 51 | 52 | if (node) 53 | return _findxmlelement(strstr(path, "/"), node); 54 | 55 | /* No node found, try attributes - which aren't indexed */ 56 | for (attr = parent->properties; attr; attr = attr->next) { 57 | if (strcmp((char*)attr->name, path) == 0) 58 | return (xmlElement*)attr; 59 | } 60 | 61 | /* No attribute either. How about content? */ 62 | if (strncmp(CONTENT_FILENAME, path, strlen(CONTENT_FILENAME)) == 0) { 63 | if (has_content(parent)) { 64 | return (xmlElement*)parent->children; 65 | } 66 | } 67 | 68 | return NULL; 69 | } 70 | 71 | xmlElement* findxmlelement(const char* path, xmlNode* root) 72 | { 73 | return _findxmlelement(path, root); 74 | } 75 | 76 | char* node_value(xmlElement* xel) 77 | { 78 | if (!xel) 79 | return NULL; 80 | 81 | if (xel->type == XML_ATTRIBUTE_NODE && xel->parent) 82 | return (char*)xmlGetProp((xmlNode*)xel->parent, xel->name); 83 | 84 | if (xel->type == XML_TEXT_NODE && xel->parent) 85 | return (char*)xmlNodeGetContent((xmlNode*)xel->parent); 86 | 87 | return NULL; 88 | } 89 | 90 | 91 | void count_twins(xmlElement* el, int *twins_before, int *twins_total) 92 | /* Count the number of equally named, equally typed elements. 93 | * twinsBefore is filled with number of twins before in list (0 for first) 94 | * twinsTotal is total number of twins, including @el) */ 95 | { 96 | int before = 0; 97 | int total = 0; 98 | xmlElement* tmp = NULL; 99 | 100 | if (!el || (!twins_before && !twins_total)) 101 | return; 102 | 103 | for (tmp = (xmlElement*)el->prev; tmp; tmp = (xmlElement*)tmp->prev) { 104 | if (el->type == tmp->type && strcmp((char*)el->name, (char*)tmp->name) == 0) 105 | before += 1; 106 | } 107 | total = before + 1; 108 | 109 | for (tmp = (xmlElement*)el->next; tmp; tmp = (xmlElement*)tmp->next) { 110 | if (el->type == tmp->type && strcmp((char*)el->name, (char*)tmp->name) == 0) 111 | total += 1; 112 | } 113 | 114 | if (twins_before) 115 | *twins_before = before; 116 | if(twins_total) 117 | *twins_total = total; 118 | } 119 | 120 | int has_content(xmlNode* node) 121 | /* Returns 1 if the node has text content 122 | * Rules are: children must be lonely child 123 | * of right type. libmlx adds text nodes 124 | * to parents that don't own them. 125 | */ 126 | { 127 | xmlNode* child = NULL; 128 | 129 | if (!node) 130 | return 0; 131 | 132 | child = node->children; 133 | if (child && !(child->next) && (child->type == XML_TEXT_NODE)) 134 | return 1; 135 | 136 | return 0; 137 | } 138 | -------------------------------------------------------------------------------- /main.c: -------------------------------------------------------------------------------- 1 | /* 2 | * xmlfs - mount an xml file as a directory structure. 3 | * Very early version. 4 | * 5 | * Copyright (c) 2009 Henrik Hallberg 6 | * Released under GPL 2 - see LICENSE for details. 7 | * Please report bugs of feature requests by email 8 | * http://github.com/halhen/xmlfs 9 | * 10 | * TODO: 11 | * UTF-8 / LOCALE support 12 | * Writing to file structure / XML 13 | * XML namespaces 14 | * XPath? 15 | * Memory leaks? 16 | * Read comments and other types 17 | * #xml containing xml for folder? 18 | */ 19 | 20 | #define FUSE_USE_VERSION 26 21 | 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | 28 | #include 29 | #include 30 | 31 | #include "global.h" 32 | #include "xmlhelpers.h" 33 | 34 | 35 | /* xml_rootparent contains only the actual root node. This node equals the path / */ 36 | xmlNode* xml_rootparent; 37 | 38 | char* create_formatted_name(xmlElement* el) 39 | { 40 | int ia, ib, ic; 41 | char* str = NULL; 42 | 43 | if (!el) 44 | return NULL; 45 | 46 | if (el->type == XML_ELEMENT_NODE) 47 | { 48 | count_twins(el, &ia, &ib); 49 | ia += INDEX_BASE; 50 | ic = (int)floor(log10(ia)) + 1; 51 | 52 | str = malloc(strlen((char*)el->name) + 2 + ic); 53 | sprintf(str, "%d.%s", ia, el->name); 54 | } 55 | else if (el->type == XML_TEXT_NODE) { 56 | str = malloc(strlen(CONTENT_FILENAME) + 1); 57 | strcpy(str, CONTENT_FILENAME); 58 | } 59 | else { 60 | str = malloc(strlen((char*)el->name) + 1); 61 | strcpy(str, (char*)el->name); 62 | } 63 | 64 | return str; 65 | } 66 | 67 | void add_to_listing(void* buf, fuse_fill_dir_t filler, xmlElement* el) 68 | { 69 | char* name = create_formatted_name(el); 70 | if (name) { 71 | filler(buf, name, NULL, 0); 72 | free(name); 73 | } 74 | } 75 | 76 | static int xmlfs_getattr(const char* path, struct stat* stbuf) 77 | { 78 | char* str = NULL; 79 | xmlElement* node = findxmlelement(path, xml_rootparent); 80 | if (!node) 81 | return -ENOENT; 82 | 83 | memset(stbuf, 0, sizeof(struct stat)); 84 | 85 | if (node->type == XML_ELEMENT_NODE) { 86 | stbuf->st_mode = S_IFDIR | 0555; 87 | stbuf->st_nlink = 2; 88 | } 89 | else { 90 | stbuf->st_mode = S_IFREG | 0444; 91 | stbuf->st_nlink = 1; 92 | 93 | str = node_value(node); 94 | if (str) { 95 | stbuf->st_size = strlen(str); 96 | xmlFree(str); 97 | } 98 | } 99 | 100 | return 0; 101 | } 102 | 103 | static int xmlfs_readdir(const char* path, void* buf, fuse_fill_dir_t filler, 104 | off_t UNUSED(offset), struct fuse_file_info* UNUSED(fi)) 105 | { 106 | xmlAttr* attr; 107 | xmlNode* node = (xmlNode*)findxmlelement(path, xml_rootparent); 108 | if (!node) 109 | return -ENOENT; 110 | 111 | filler(buf, ".", NULL, 0); 112 | filler(buf, "..", NULL, 0); 113 | 114 | for (attr = node->properties; attr; attr = attr->next) { 115 | add_to_listing(buf, filler, (xmlElement*)attr); 116 | } 117 | 118 | for (node = node->children ; node; node = node->next) { 119 | if (node->type == XML_ELEMENT_NODE) { 120 | add_to_listing(buf, filler, (xmlElement*)node); 121 | } 122 | else if (has_content(node->parent)) { 123 | add_to_listing(buf, filler, (xmlElement*)node); 124 | } 125 | } 126 | 127 | return 0; 128 | } 129 | 130 | static int xmlfs_open(const char *path, struct fuse_file_info *fi) 131 | { 132 | xmlElement *xel = findxmlelement(path, xml_rootparent); 133 | 134 | if (!xel) 135 | return -ENOENT; 136 | 137 | if ((fi->flags & 3) != O_RDONLY) 138 | return -EACCES; 139 | 140 | return 0; 141 | } 142 | 143 | static int xmlfs_read(const char *path, char *buf, size_t size, 144 | off_t offset, struct fuse_file_info *UNUSED(fi)) 145 | { 146 | size_t len; 147 | char* content = NULL; 148 | xmlElement *xel = findxmlelement(path, xml_rootparent); 149 | 150 | if (!xel) 151 | return -ENOENT; 152 | 153 | content = node_value(xel); 154 | 155 | if (!content) { 156 | fprintf(stderr, "Error: File %s gives NULL content.", path); 157 | return -EINVAL; /* Which code is correct? Can this happen? */ 158 | } 159 | 160 | len = strlen(content); 161 | if (offset < len) { 162 | if (offset + size > len) { 163 | size = len - offset; 164 | } 165 | memcpy(buf, content + offset, size); 166 | } else 167 | size = 0; 168 | 169 | xmlFree(content); 170 | return size; 171 | } 172 | 173 | static struct fuse_operations fileops = { 174 | .getattr = xmlfs_getattr, 175 | .readdir = xmlfs_readdir, 176 | .open = xmlfs_open, 177 | .read = xmlfs_read, 178 | }; 179 | 180 | /* Command line parsing. Should be cleaned up a bit */ 181 | struct xmlfs_config { 182 | char* xmlfile; 183 | }; 184 | 185 | enum { 186 | KEY_HELP, 187 | KEY_VERSION, 188 | }; 189 | 190 | static struct fuse_opt xmlfs_opts[] = { 191 | {"xmlfile=%s", 0, 0}, 192 | FUSE_OPT_KEY("-v", KEY_VERSION), 193 | FUSE_OPT_KEY("--version", KEY_VERSION), 194 | FUSE_OPT_KEY("-h", KEY_HELP), 195 | FUSE_OPT_KEY("--help", KEY_HELP), 196 | FUSE_OPT_END 197 | }; 198 | 199 | static int xmlfs_opt_proc(void* UNUSED(data), const char* UNUSED(arg), int key, struct fuse_args *outargs) 200 | { 201 | switch(key) { 202 | case KEY_HELP: 203 | fprintf(stderr, "xmlfs mounts an xml file as a directory structure.\n" 204 | "Nodes become directories, with an index in front of the name\n" 205 | "Attributes become files, name accordingly and contains the value\n" 206 | "Node content text is stored in a file named '#text'\n" 207 | "\n" 208 | "Currently works in best case - simple XML and ASCII characters.\n" 209 | "\n" 210 | "usage: %s mountpoint [options]\n" 211 | "\n" 212 | "general options:\n" 213 | " -o opt,[opt...] mount options\n" 214 | " -h --help print help\n" 215 | " -v --version print version\n" 216 | "\n" 217 | "xmlfs options:\n" 218 | " -o xmlfile=FILENAME stdin if not specified\n", 219 | outargs->argv[0]); 220 | fuse_opt_add_arg(outargs, "-ho"); 221 | fuse_main(outargs->argc, outargs->argv, &fileops, NULL); 222 | exit(1); 223 | case KEY_VERSION: 224 | fprintf(stderr, "xmlfs version 0.1.1\n"); 225 | fuse_opt_add_arg(outargs, "--version"); 226 | fuse_main(outargs->argc, outargs->argv, &fileops, NULL); 227 | exit(0); 228 | } 229 | 230 | return 1; 231 | } 232 | 233 | int main(int argc, char* argv[]) 234 | { 235 | int ret = 0; 236 | struct xmlfs_config conf; 237 | struct fuse_args args = FUSE_ARGS_INIT(argc, argv); 238 | 239 | xmlDoc* xmldoc = NULL; 240 | const char* xmlfile = "/dev/stdin"; 241 | 242 | memset(&conf, 0, sizeof(conf)); 243 | fuse_opt_parse(&args, &conf, xmlfs_opts, xmlfs_opt_proc); 244 | 245 | if (conf.xmlfile) 246 | xmlfile = conf.xmlfile; 247 | 248 | xmldoc = xmlReadFile(xmlfile, NULL, 0); 249 | 250 | if (xmldoc == NULL) { 251 | fprintf(stderr, "Could not read XML\n"); 252 | return 1; 253 | } 254 | 255 | /* FIXME: better way of having root node as top directory 256 | * This way causes some strange free's at exit according to valgrind */ 257 | xml_rootparent = xmlNewNode(NULL, (xmlChar*)"xmlfs_root"); 258 | if (!xmlAddChild(xml_rootparent, xmlDocGetRootElement(xmldoc))) { 259 | fprintf(stderr, "Error creating XML node\n"); 260 | return 1; 261 | } 262 | 263 | ret = fuse_main(args.argc, args.argv, &fileops, NULL); 264 | 265 | xmlFreeDoc(xmldoc); 266 | xmlCleanupParser(); 267 | if (conf.xmlfile) 268 | free(conf.xmlfile); 269 | fuse_opt_free_args(&args); 270 | 271 | return ret; 272 | } 273 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | --------------------------------------------------------------------------------