├── .gitignore ├── .Rbuildignore ├── tests ├── testthat.R └── testthat │ └── test_smmry_api.R ├── NAMESPACE ├── inst └── rstudio │ └── addins.dcf ├── Rsmmry.Rproj ├── DESCRIPTION ├── .travis.yml ├── man └── smmry_api.Rd ├── README.md ├── R └── smmry_api.R └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .Rproj.user 2 | .Rhistory 3 | .RData 4 | .Ruserdata 5 | -------------------------------------------------------------------------------- /.Rbuildignore: -------------------------------------------------------------------------------- 1 | ^.*\.Rproj$ 2 | ^\.Rproj\.user$ 3 | ^\.travis\.yml$ 4 | -------------------------------------------------------------------------------- /tests/testthat.R: -------------------------------------------------------------------------------- 1 | library(testthat) 2 | library(Rsmmry) 3 | 4 | test_check("Rsmmry") 5 | -------------------------------------------------------------------------------- /NAMESPACE: -------------------------------------------------------------------------------- 1 | # Generated by roxygen2: do not edit by hand 2 | 3 | export(smmry_api) 4 | importFrom(magrittr,"%>%") 5 | -------------------------------------------------------------------------------- /inst/rstudio/addins.dcf: -------------------------------------------------------------------------------- 1 | Name: rsmmry 2 | Description: calls SMMRY API to give back a summery of a text 3 | Binding: smmry_api 4 | Interactive: true -------------------------------------------------------------------------------- /Rsmmry.Rproj: -------------------------------------------------------------------------------- 1 | Version: 1.0 2 | 3 | RestoreWorkspace: Default 4 | SaveWorkspace: Default 5 | AlwaysSaveHistory: Default 6 | 7 | EnableCodeIndexing: Yes 8 | UseSpacesForTab: Yes 9 | NumSpacesForTab: 2 10 | Encoding: UTF-8 11 | 12 | RnwWeave: Sweave 13 | LaTeX: pdfLaTeX 14 | 15 | BuildType: Package 16 | PackageUseDevtools: Yes 17 | PackageInstallArgs: --no-multiarch --with-keep.source 18 | PackageRoxygenize: rd,collate,namespace 19 | -------------------------------------------------------------------------------- /DESCRIPTION: -------------------------------------------------------------------------------- 1 | Package: Rsmmry 2 | Title: API for SMMRY 3 | Version: 0.0.0.9000 4 | Author: c( 5 | person("Clemens", "Schmid", email = "clemens@nevrome.de", role = c("cre", "cph", "aut")) 6 | ) 7 | Maintainer: Clemens Schmid 8 | Description: Allows to send API requests to SMMRY. SMMRY offers a 9 | web service to automatically summarize text. 10 | Date: 2017-04-22 11 | Depends: R (>= 3.3.3) 12 | License: GPL-2 | file LICENSE 13 | Encoding: UTF-8 14 | LazyData: true 15 | RoxygenNote: 6.0.1 16 | Imports: 17 | clipr (>= 0.3.2), 18 | curl (>= 2.4), 19 | httr (>= 1.2.1), 20 | magrittr (>= 1.5), 21 | RCurl (>= 1.95-4.8) 22 | Suggests: 23 | testthat 24 | SystemRequirements: 25 | tools needed by clipr (see https://github.com/mdlincoln/clipr) 26 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: R 2 | cache: packages 3 | r_packages: 4 | - covr 5 | 6 | matrix: 7 | include: 8 | - os: linux 9 | dist: trusty 10 | sudo: false 11 | env: R_CODECOV=true 12 | 13 | warnings_are_errors: true 14 | 15 | after_success: 16 | - Rscript -e 'library(covr); codecov()' 17 | 18 | env: 19 | global: 20 | secure: pvgkd+5Y4TDNXzhaNLQSCTiiJNTYEgl+EiZJ3VruuXVd8XLpdrg6AMDIZBcJHXNyu//sw0MXfaWZllHottFcAR+fcbfkp+Ovau+NdnYrogGztXvW1U7iBCwsFKL8SNMwSMITKhoGxcEXMoN+/HnxTiU1jFBekNPkCky5ws83j+RG90BmePCyN0cJGl0MDnODZ+47dUzdIxesi78757AsQbEi3FpO/MVoFuj+YW/kTxLqdtuMwLtX6LHDhTpCPtFM84VpPTxGaF7WiQgUE4TU5KhzmbPlbfgHlMOTjQBVt95lU4zgJR1IbqPnnnl+KStjkR37iqz10F4Muu8ukSJg/+y7VU/9v0eYUlS2p5XmuHHFzxm2Yss2w+oqw4xMSWH8FUAE6wpMBbkHQPgyGxTy1cmboQupK62+Sjw1SVi7wgkw34NwK7xDx8uWlF0QZROyusPCdf+WmH3pafhjlhQeSAuXpGdFOv2Xw/SNWkr10nJpn69VIdsdyeWfJdho3R6e18nom4ryT7fEICJ4t3I1iKBaybEZkphYGuZgoB88wsCRzbIQWotlv4uJ8B5caWc2ENPJuTbbKx9gesPrLQXZVQ0WZeGmGWGsFrdBSfXPUV2qlRBnU0PuLDc1TtAEgQpkHE5itCj+d3n2D7sFCYi9ZK+UJc/IvbfRBNuQ0/YlwS4= 21 | -------------------------------------------------------------------------------- /tests/testthat/test_smmry_api.R: -------------------------------------------------------------------------------- 1 | context("Tests of the SMMRY api function") 2 | 3 | lorem_ipsum <- "Lorem ipsum dolor sit amet, consetetur 4 | sadipscing elitr, sed diam nonumy eirmod 5 | tempor invidunt ut labore et dolore magna 6 | aliquyam erat, sed diam voluptua. At vero 7 | eos et accusam et justo duo dolores et ea 8 | rebum. Stet clita kasd gubergren, no sea 9 | takimata sanctus est Lorem ipsum dolor sit 10 | amet. Lorem ipsum dolor sit amet, consetetur 11 | sadipscing elitr, sed diam nonumy eirmod 12 | tempor invidunt ut labore et dolore magna 13 | aliquyam erat, sed diam voluptua. At vero 14 | eos et accusam et justo duo dolores et ea 15 | rebum. Stet clita kasd gubergren, no sea 16 | takimata sanctus est Lorem ipsum dolor sit 17 | amet." 18 | 19 | testurl <- "https://en.wikipedia.org/wiki/Aregund" 20 | 21 | ts <- smmry_api(x = lorem_ipsum) 22 | tl <- smmry_api(x = lorem_ipsum, quick = FALSE) 23 | us <- smmry_api(x = testurl) 24 | 25 | test_that("smmry_api produces a string, if quick = TRUE", { 26 | testthat::skip_on_cran() 27 | expect_type(ts, "character") 28 | expect_type(us, "character") 29 | }) 30 | 31 | test_that("smmry_api produces a smmry_api object, if quick = FALSE", { 32 | testthat::skip_on_cran() 33 | expect_s3_class(tl, "smmry_api") 34 | }) -------------------------------------------------------------------------------- /man/smmry_api.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/smmry_api.R 3 | \name{smmry_api} 4 | \alias{smmry_api} 5 | \title{R API to access the SMMRY web service} 6 | \usage{ 7 | smmry_api(x = NULL, quick = TRUE, isurl = NULL, length = NULL, 8 | keywords = NULL, quote_avoid = FALSE, breaks = FALSE) 9 | } 10 | \arguments{ 11 | \item{x}{string. text \bold{or} url of the webpage to 12 | summarize - uses data from clipboard, if x is not set} 13 | 14 | \item{quick}{boolean. switch to decide if the result should 15 | be just the reduced text (default = \code{TRUE}), 16 | or a comprehensiv list of the API output 17 | (\code{FALSE})} 18 | 19 | \item{isurl}{boolean. switch to decide if x should be treated 20 | as text (\code{FALSE}) or url (\code{TRUE}). 21 | If nothing is set (default = \code{NULL}), the 22 | function decides autonomously} 23 | 24 | \item{length}{integer. number of sentences returned by SMMRY, 25 | (default = \code{7})} 26 | 27 | \item{keywords}{integer. number of top keywords returned by 28 | SMMRY} 29 | 30 | \item{quote_avoid}{boolean. switch to decide if the SMMRY 31 | result should (default = \code{FALSE}) or 32 | shouldn't (\code{TRUE}) include quotations} 33 | 34 | \item{breaks}{boolean. switch to decide if the SMMRY result 35 | should (\code{TRUE}) or shouldn't 36 | (default = \code{FALSE}) contain the string 37 | "[BREAK]" between each sentence} 38 | } 39 | \description{ 40 | SMMRY offers a service to automatically summarize 41 | a webpage or simply text. \code{smmry_api} allows 42 | to access this service from within R. To use it 43 | you need a SMMRY API Key (\url{http://smmry.com/api}) 44 | that has to be set as a environment variable 45 | \code{SMMRY_PAT}. 46 | } 47 | \examples{ 48 | lorem_ipsum <- "Lorem ipsum dolor sit amet, consetetur 49 | sadipscing elitr, sed diam nonumy eirmod 50 | tempor invidunt ut labore et dolore magna 51 | aliquyam erat, sed diam voluptua. At vero 52 | eos et accusam et justo duo dolores et ea 53 | rebum. Stet clita kasd gubergren, no sea 54 | takimata sanctus est Lorem ipsum dolor sit 55 | amet. Lorem ipsum dolor sit amet, consetetur 56 | sadipscing elitr, sed diam nonumy eirmod 57 | tempor invidunt ut labore et dolore magna 58 | aliquyam erat, sed diam voluptua. At vero 59 | eos et accusam et justo duo dolores et ea 60 | rebum. Stet clita kasd gubergren, no sea 61 | takimata sanctus est Lorem ipsum dolor sit 62 | amet." 63 | 64 | testurl <- "https://en.wikipedia.org/wiki/Aregund" 65 | 66 | \donttest{ 67 | smmry_api(x = lorem_ipsum) 68 | smmry_api(x = lorem_ipsum, quick = FALSE) 69 | smmry_api(x = testurl) 70 | smmry_api(x = testurl, quick = FALSE) 71 | } 72 | 73 | } 74 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Travis-CI Build Status](https://travis-ci.org/nevrome/Rsmmry.svg?branch=master)](https://travis-ci.org/nevrome/Rsmmry) [![Coverage Status](https://img.shields.io/codecov/c/github/nevrome/Rsmmry/master.svg)](https://codecov.io/github/nevrome/Rsmmry?branch=master) 2 | [![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/Rsmmry)](http://cran.r-project.org/package=Rsmmry) 3 | [![license](https://img.shields.io/badge/license-GPL%202-B50B82.svg)](https://www.r-project.org/Licenses/GPL-2) 4 | 5 | Rsmmry 6 | -------- 7 | 8 | [SMMRY](http://smmry.com/) offers a service to automatically summarize a webpage or simply text. Rsmmry allows to access this service from within R. 9 | 10 | Could be useful in combination with packages like [antiword](http://cran.r-project.org/package=antiword) or [tm](https://CRAN.R-project.org/package=tm) that allow text mining. 11 | 12 | Installation 13 | ------------ 14 | 15 | Rsmmry is currently not on [CRAN](http://cran.r-project.org/), but you can use [devtools](http://cran.r-project.org/web/packages/devtools/index.html) to install the development version. To do so: 16 | 17 | if(!require('devtools')) install.packages('devtools') 18 | library(devtools) 19 | install_github('nevrome/Rsmmry') 20 | 21 | Usage 22 | ----- 23 | 24 | To use Rsmmry you first of all need a SMMRY API Key (http://smmry.com/api) that has to be [set as a environment variable SMMRY_PAT](https://cran.r-project.org/web/packages/httr/vignettes/api-packages.html#appendix-storing-api-authentication-keystokens). 25 | 26 | With this done, you can call the main function smmry_api() to summarize text or a website. 27 | 28 | ```{r} 29 | lorem_ipsum <- "Lorem ipsum dolor sit amet, consetetur 30 | sadipscing elitr, sed diam nonumy eirmod 31 | tempor invidunt ut labore et dolore magna 32 | aliquyam erat, sed diam voluptua. At vero 33 | eos et accusam et justo duo dolores et ea 34 | rebum. Stet clita kasd gubergren, no sea 35 | takimata sanctus est Lorem ipsum dolor sit 36 | amet. Lorem ipsum dolor sit amet, consetetur 37 | sadipscing elitr, sed diam nonumy eirmod 38 | tempor invidunt ut labore et dolore magna 39 | aliquyam erat, sed diam voluptua. At vero 40 | eos et accusam et justo duo dolores et ea 41 | rebum. Stet clita kasd gubergren, no sea 42 | takimata sanctus est Lorem ipsum dolor sit 43 | amet." 44 | 45 | testurl <- "https://en.wikipedia.org/wiki/Aregund" 46 | 47 | smmry_api(x = lorem_ipsum) 48 | smmry_api(x = testurl) 49 | ``` 50 | 51 | The package provides a RStudio Addin named rsmmry that binds to smmry_api() to summarize text (or homepages) in the clipboard. smmry_api() can therefore be called with a keyboard shortcut in RStudio. 52 | 53 | Licence 54 | ------- 55 | 56 | Rsmmry is released under the [GNU General Public Licence, version 2](http://www.r-project.org/Licenses/GPL-2). Comments and feedback are welcome, as are code contributions. 57 | 58 | I'm not affiliated with the the team behind SMMRY - I just wanted to provide a convinient way to use their API. -------------------------------------------------------------------------------- /R/smmry_api.R: -------------------------------------------------------------------------------- 1 | #' R API to access the SMMRY web service 2 | #' 3 | #' SMMRY offers a service to automatically summarize 4 | #' a webpage or simply text. \code{smmry_api} allows 5 | #' to access this service from within R. To use it 6 | #' you need a SMMRY API Key (\url{http://smmry.com/api}) 7 | #' that has to be set as a environment variable 8 | #' \code{SMMRY_PAT}. 9 | #' 10 | #' @param x string. text \bold{or} url of the webpage to 11 | #' summarize - uses data from clipboard, if x is not set 12 | #' @param quick boolean. switch to decide if the result should 13 | #' be just the reduced text (default = \code{TRUE}), 14 | #' or a comprehensiv list of the API output 15 | #' (\code{FALSE}) 16 | #' @param isurl boolean. switch to decide if x should be treated 17 | #' as text (\code{FALSE}) or url (\code{TRUE}). 18 | #' If nothing is set (default = \code{NULL}), the 19 | #' function decides autonomously 20 | #' @param length integer. number of sentences returned by SMMRY, 21 | #' (default = \code{7}) 22 | #' @param keywords integer. number of top keywords returned by 23 | #' SMMRY 24 | #' @param quote_avoid boolean. switch to decide if the SMMRY 25 | #' result should (default = \code{FALSE}) or 26 | #' shouldn't (\code{TRUE}) include quotations 27 | #' @param breaks boolean. switch to decide if the SMMRY result 28 | #' should (\code{TRUE}) or shouldn't 29 | #' (default = \code{FALSE}) contain the string 30 | #' "[BREAK]" between each sentence 31 | #' 32 | #' @examples 33 | #' lorem_ipsum <- "Lorem ipsum dolor sit amet, consetetur 34 | #' sadipscing elitr, sed diam nonumy eirmod 35 | #' tempor invidunt ut labore et dolore magna 36 | #' aliquyam erat, sed diam voluptua. At vero 37 | #' eos et accusam et justo duo dolores et ea 38 | #' rebum. Stet clita kasd gubergren, no sea 39 | #' takimata sanctus est Lorem ipsum dolor sit 40 | #' amet. Lorem ipsum dolor sit amet, consetetur 41 | #' sadipscing elitr, sed diam nonumy eirmod 42 | #' tempor invidunt ut labore et dolore magna 43 | #' aliquyam erat, sed diam voluptua. At vero 44 | #' eos et accusam et justo duo dolores et ea 45 | #' rebum. Stet clita kasd gubergren, no sea 46 | #' takimata sanctus est Lorem ipsum dolor sit 47 | #' amet." 48 | #' 49 | #' testurl <- "https://en.wikipedia.org/wiki/Aregund" 50 | #' 51 | #' \donttest{ 52 | #' smmry_api(x = lorem_ipsum) 53 | #' smmry_api(x = lorem_ipsum, quick = FALSE) 54 | #' smmry_api(x = testurl) 55 | #' smmry_api(x = testurl, quick = FALSE) 56 | #' } 57 | #' 58 | #' @importFrom magrittr "%>%" 59 | #' 60 | #' @export 61 | smmry_api <- function( 62 | x = NULL, quick = TRUE, isurl = NULL, length = NULL, 63 | keywords = NULL, quote_avoid = FALSE, breaks = FALSE 64 | ) { 65 | 66 | # check for an internet connection 67 | if (!curl::has_internet()) { 68 | stop("No internet connection. Can't use SMMRY API.") 69 | } 70 | 71 | # set user agent 72 | ua <- httr::user_agent("http://github.com/nevrome/Rsmmry") 73 | 74 | # check, if access token to SMMRY is available 75 | pat <- Sys.getenv('SMMRY_PAT') 76 | if (identical(pat, "")) { 77 | stop( 78 | "Please set env var SMMRY_PAT to your SMMRY personal access token. 79 | See https://github.com/nevrome/Rsmmry for more info.", 80 | call. = FALSE 81 | ) 82 | } 83 | 84 | # check if x is empty and try to access the clipboard 85 | if (is.null(x) && clipr::clipr_available()) { 86 | x <- clipr::read_clip() %>% paste(collapse = ' ') 87 | message("x is not set - using data from clipboard.") 88 | } 89 | 90 | # check if x is a file system link and read data from there 91 | if (file.exists(x)) { 92 | x <- readLines(x) %>% paste(collapse = ' ') 93 | message( 94 | "x seems to be a file system link - using data from this file." 95 | ) 96 | } 97 | 98 | # check, if input x is a currently working url 99 | # only if isurl is not set (NULL) 100 | if (is.null(isurl) && RCurl::url.exists(x)) { 101 | isurl <- TRUE 102 | message("x seems to be a url - using homepage.") 103 | } 104 | 105 | # remove breaks from input x 106 | x <- gsub("[\r\n]", "", x) 107 | 108 | # remove multiple spaces from input x 109 | x <- gsub( 110 | "(?<=[\\s])\\s*|^\\s+|\\s+$", "", 111 | x, 112 | perl = TRUE 113 | ) 114 | 115 | # parse url for api call 116 | url <- httr::modify_url( 117 | "http://api.smmry.com", 118 | path = paste0(c( 119 | # api key 120 | paste0("&SM_API_KEY=", pat), 121 | # amount of sentences 122 | ifelse( 123 | !is.null(length), 124 | paste0("&SM_LENGTH=", length), 125 | "" 126 | ), 127 | # amount of keywords 128 | ifelse( 129 | !is.null(url), 130 | paste0("&SM_KEYWORD_COUNT=", keywords), 131 | "" 132 | ), 133 | # avoid quotes 134 | ifelse( 135 | quote_avoid, 136 | paste0("&SM_QUOTE_AVOID", quote_avoid), 137 | "" 138 | ), 139 | # breaks between sentences 140 | ifelse( 141 | breaks, 142 | paste0("&SM_WITH_BREAK"), 143 | "" 144 | ), 145 | # input url 146 | ifelse( 147 | isurl, 148 | paste0("&SM_URL=", x), 149 | "" 150 | ) 151 | ), collapse = "") 152 | ) 153 | 154 | # API request 155 | api_result_raw <- url %>% 156 | # add text data and send to smmry 157 | httr::POST( 158 | body = list(sm_api_input = x) 159 | ) 160 | 161 | # catch and print http errors 162 | if (httr::http_error(api_result_raw)) { 163 | stop( 164 | sprintf( 165 | "HTTP Error: ", 166 | httr::status_code(api_result_raw) 167 | ), 168 | call. = FALSE 169 | ) 170 | } 171 | 172 | # extract content from request 173 | api_result <- api_result_raw %>% httr::content(as = "parsed") 174 | 175 | # catch and print SMMRY notices, warnings, and error 176 | # messages 177 | if (exists('sm_api_message', where = api_result)) { 178 | message( 179 | "SMMRY API message: ", 180 | api_result[["sm_api_message"]] 181 | ) 182 | } 183 | 184 | # catch and print SMMRY limitation message 185 | if (exists('sm_api_limitation', where = api_result)) { 186 | message( 187 | "SMMRY API limitations: ", 188 | api_result[["sm_api_limitation"]] 189 | ) 190 | } 191 | 192 | # remove mysterious leading whitespace in sm_api_content 193 | api_result[["sm_api_content"]] <- sub( 194 | "^\\s+", "", 195 | api_result[["sm_api_content"]] 196 | ) 197 | 198 | # setup output 199 | if (quick) { 200 | 201 | # return just reduced text 202 | return(api_result[["sm_api_content"]]) 203 | 204 | } else { 205 | 206 | # put complete api_result in own S3 data structure 207 | result <- structure( 208 | api_result, 209 | class = "smmry_api" 210 | ) 211 | 212 | return(result) 213 | } 214 | } -------------------------------------------------------------------------------- /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 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | --------------------------------------------------------------------------------