├── AUTHORS ├── Gemfile ├── .travis.yml ├── .gitignore ├── licenses ├── Boost.erb ├── ASL2.erb ├── GPL3.erb ├── AGPL3.erb ├── LGPL3.erb ├── MIT.erb ├── BSD-2-CLAUSE.erb ├── BSD-3-CLAUSE.erb └── BSD-4-CLAUSE.erb ├── Rakefile ├── lib ├── copyright_header │ ├── version.rb │ ├── command_line.rb │ └── parser.rb └── copyright_header.rb ├── Dockerfile ├── bin └── copyright-header ├── copyright-header.gemspec ├── Makefile ├── contrib └── syntax.yml ├── README.yaml ├── README.md └── LICENSE /AUTHORS: -------------------------------------------------------------------------------- 1 | Erik Osterman - Initial version 2 | Ryan Faircloth - Contributions 3 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source "http://rubygems.org" 2 | 3 | # Specify your gem's dependencies in copyright_header.gemspec 4 | gemspec 5 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | addons: 2 | apt: 3 | packages: 4 | - git 5 | - make 6 | - curl 7 | 8 | install: 9 | - make init -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | pkg/ 2 | # Compiled files 3 | *.tfstate 4 | *.tfstate.backup 5 | 6 | # Module directory 7 | .terraform 8 | .idea 9 | *.iml 10 | 11 | .build-harness 12 | build-harness 13 | -------------------------------------------------------------------------------- /licenses/Boost.erb: -------------------------------------------------------------------------------- 1 | <%=copyright_software%>: <%=copyright_software_description%> 2 | Copyright (C) <%=copyright_years.join(', ')%> <%=copyright_holders.join(', ')%> 3 | 4 | This software is distributed under the Boost Software License, Version 1.0. 5 | See accompanying file LICENSE or copy at http://boost.org/LICENSE_1_0.txt 6 | -------------------------------------------------------------------------------- /licenses/ASL2.erb: -------------------------------------------------------------------------------- 1 | <%=copyright_software%> - <%=copyright_software_description%> 2 | 3 | Copyright <%=copyright_years.join(', ')%> <%=copyright_holders.join(', ')%> 4 | 5 | Licensed under the Apache License, Version 2.0 (the "License"); 6 | you may not use this file except in compliance with the License. 7 | You may obtain a copy of the License at 8 | 9 | http://www.apache.org/licenses/LICENSE-2.0 10 | 11 | Unless required by applicable law or agreed to in writing, software 12 | distributed under the License is distributed on an "AS IS" BASIS, 13 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | See the License for the specific language governing permissions and 15 | limitations under the License. 16 | -------------------------------------------------------------------------------- /licenses/GPL3.erb: -------------------------------------------------------------------------------- 1 | <%=copyright_software%> - <%=copyright_software_description%> 2 | Copyright (C) <%=copyright_years.join(', ')%> <%=copyright_holders.join(', ')%> 3 | 4 | This file is part of <%=copyright_software%>. 5 | 6 | <%=copyright_software%> is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU General Public License as published by 8 | the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | <%=copyright_software%> is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU General Public License for more details. 15 | 16 | You should have received a copy of the GNU General Public License 17 | along with <%=copyright_software%>. If not, see . 18 | -------------------------------------------------------------------------------- /licenses/AGPL3.erb: -------------------------------------------------------------------------------- 1 | <%=copyright_software%> - <%=copyright_software_description%> 2 | Copyright (C) <%=copyright_years.join(', ')%> <%=copyright_holders.join(', ')%> 3 | 4 | This file is part of <%=copyright_software%>. 5 | 6 | <%=copyright_software%> is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Affero General Public License as 8 | published by the Free Software Foundation, either version 3 of the 9 | License, or (at your option) any later version. 10 | 11 | <%=copyright_software%> is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Affero General Public License for more details. 15 | 16 | You should have received a copy of the GNU Affero General Public License 17 | along with <%=copyright_software%>. If not, see . 18 | -------------------------------------------------------------------------------- /licenses/LGPL3.erb: -------------------------------------------------------------------------------- 1 | <%=copyright_software%> - <%=copyright_software_description%> 2 | Copyright (C) <%=copyright_years.join(', ')%> <%=copyright_holders.join(', ')%> 3 | 4 | This file is part of <%=copyright_software%>. 5 | 6 | <%=copyright_software%> is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Lesser General Public License as published by 8 | the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | <%=copyright_software%> is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with <%=copyright_software%>. If not, see . 18 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright Header - A utility to manipulate copyright headers on source code files 3 | # Copyright (C) 2017 Erik Osteman 4 | # 5 | # This file is part of Copyright Header. 6 | # 7 | # Copyright Header is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # Copyright Header is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with Copyright Header. If not, see . 19 | # 20 | require "bundler/gem_tasks" 21 | -------------------------------------------------------------------------------- /lib/copyright_header/version.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright Header - A utility to manipulate copyright headers on source code files 3 | # Copyright (C) 2012-2016 Erik Osterman 4 | # 5 | # This file is part of Copyright Header. 6 | # 7 | # Copyright Header is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # Copyright Header is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with Copyright Header. If not, see . 19 | # 20 | module CopyrightHeader 21 | VERSION = "1.0.22" 22 | end 23 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM ubuntu:18.04 2 | 3 | RUN apt-get update && \ 4 | apt-get -y install ruby ruby-dev git make build-essential libicu-dev zlib1g-dev cmake pkg-config cmake libssl-dev 5 | 6 | # Set the locale 7 | # make the "en_US.UTF-8" locale so ruby will be utf-8 enabled by default 8 | RUN apt-get update && apt-get install -y --no-install-recommends apt-utils && apt-get install -y locales && rm -rf /var/lib/apt/lists/* \ 9 | && localedef -i en_US -c -f UTF-8 -A /usr/share/locale/locale.alias en_US.UTF-8 10 | RUN sed -i -e 's/# en_US.UTF-8 UTF-8/en_US.UTF-8 UTF-8/' /etc/locale.gen && \ 11 | locale-gen 12 | ENV LANG en_US.UTF-8 13 | ENV LANGUAGE en_US:en 14 | ENV LC_ALL en_US.UTF-8 15 | 16 | ADD . /tmp/copyright-header/ 17 | ADD .git /tmp/copyright-header/.git 18 | 19 | WORKDIR /tmp/copyright-header/ 20 | 21 | RUN gem build copyright-header.gemspec && \ 22 | gem install copyright-header-*.gem && \ 23 | rm -rf /tmp/copyright-header 24 | 25 | VOLUME ["/usr/src"] 26 | 27 | WORKDIR /usr/src 28 | 29 | ENTRYPOINT ["/usr/local/bin/copyright-header"] 30 | -------------------------------------------------------------------------------- /lib/copyright_header.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright Header - A utility to manipulate copyright headers on source code files 3 | # Copyright (C) 2012-2016 Erik Osterman 4 | # 5 | # This file is part of Copyright Header. 6 | # 7 | # Copyright Header is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # Copyright Header is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with Copyright Header. If not, see . 19 | # 20 | require 'copyright_header/version' 21 | require 'copyright_header/command_line' 22 | require 'copyright_header/parser' 23 | 24 | module CopyrightHeader 25 | end 26 | -------------------------------------------------------------------------------- /licenses/MIT.erb: -------------------------------------------------------------------------------- 1 | Copyright (C) <%=copyright_years.join(', ')%> <%=copyright_holders.join(', ')%> 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 4 | 5 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 6 | 7 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 8 | -------------------------------------------------------------------------------- /bin/copyright-header: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | # 3 | # Copyright Header - A utility to manipulate copyright headers on source code files 4 | # Copyright (C) 2012-2016 Erik Osterman 5 | # 6 | # This file is part of Copyright Header. 7 | # 8 | # Copyright Header is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License as published by 10 | # the Free Software Foundation, either version 3 of the License, or 11 | # (at your option) any later version. 12 | # 13 | # Copyright Header is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU General Public License for more details. 17 | # 18 | # You should have received a copy of the GNU General Public License 19 | # along with Copyright Header. If not, see . 20 | # 21 | $:.unshift(File.expand_path('.')) # Ruby 1.9 doesn't have . in the load path... 22 | $:.push(File.expand_path('lib/')) 23 | 24 | require 'rubygems' 25 | require 'copyright_header' 26 | 27 | command_line = CopyrightHeader::CommandLine.new 28 | command_line.execute 29 | -------------------------------------------------------------------------------- /copyright-header.gemspec: -------------------------------------------------------------------------------- 1 | # -*- encoding: utf-8 -*- 2 | 3 | $:.push File.expand_path("../lib", __FILE__) 4 | require "copyright_header/version" 5 | 6 | if RUBY_VERSION =~ /1.9/ # assuming you're running Ruby ~1.9 7 | Encoding.default_external = Encoding::UTF_8 8 | Encoding.default_internal = Encoding::UTF_8 9 | end 10 | 11 | Gem::Specification.new do |s| 12 | s.name = "copyright-header" 13 | s.version = CopyrightHeader::VERSION 14 | s.authors = ["Erik Osterman"] 15 | s.email = ["e@osterman.com"] 16 | s.licenses = ["GPL-3.0"] 17 | s.homepage = "https://github.com/osterman/copyright-header" 18 | s.summary = %q{A utility to insert copyright headers into various types of source code files} 19 | s.description = %q{A utility which is able to recursively insert and remove copyright headers from source code files based on file extensions.} 20 | s.rubyforge_project = "copyright-header" 21 | 22 | s.files = `git ls-files`.split("\n") 23 | s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n") 24 | s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) } 25 | s.extra_rdoc_files = ['README.md', 'LICENSE', 'AUTHORS', 'contrib/syntax.yml' ] 26 | s.require_paths = ["lib"] 27 | s.add_runtime_dependency('github-linguist','~>6.0') 28 | end 29 | -------------------------------------------------------------------------------- /licenses/BSD-2-CLAUSE.erb: -------------------------------------------------------------------------------- 1 | Copyright (c) <%=copyright_years.join(', ')%> <%=copyright_holders.join(', ')%> 2 | All rights reserved. 3 | 4 | Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 5 | 6 | * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 7 | * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 8 | 9 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 10 | -------------------------------------------------------------------------------- /licenses/BSD-3-CLAUSE.erb: -------------------------------------------------------------------------------- 1 | Copyright (c) <%=copyright_years.join(', ')%> <%=copyright_holders.join(', ')%> 2 | All rights reserved. 3 | 4 | Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 5 | 6 | * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 7 | * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 8 | * Neither the name of %ORGANIZATION% nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 9 | 10 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 11 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | SHELL := /bin/bash 2 | 3 | -include $(shell curl -sSL -o .build-harness "https://cloudposse.tools/build-harness"; echo .build-harness) 4 | 5 | #COPYRIGHT_CMD ?= copyright-header 6 | COPYRIGHT_CMD ?= docker run --rm --volume `pwd`:$(COPYRIGHT_OUTPUT_DIR) osterman/copyright-header:latest 7 | COPYRIGHT_LICENSE ?= GPL3 8 | COPYRIGHT_HOLDER ?= Erik Osterman 9 | COPYRIGHT_YEAR ?= 2012-2017 10 | COPYRIGHT_SOFTWARE ?= Copyright Header 11 | COPYRIGHT_SOFTWARE_DESCRIPTION ?= A utility to manipulate copyright headers on source code files 12 | COPYRIGHT_OUTPUT_DIR ?= /usr/src 13 | COPYRIGHT_WORD_WRAP ?= 100 14 | COPYRIGHT_PATHS ?= lib/:bin/:contrib/ 15 | 16 | remove-copyright: 17 | $(COPYRIGHT_CMD) \ 18 | --license $(COPYRIGHT_LICENSE) \ 19 | --remove-path $(COPYRIGHT_PATHS) \ 20 | --guess-extension \ 21 | --copyright-holder '$(COPYRIGHT_HOLDER)' \ 22 | --copyright-software '$(COPYRIGHT_SOFTWARE)' \ 23 | --copyright-software-description '$(COPYRIGHT_SOFTWARE_DESCRIPTION)' \ 24 | --copyright-year $(COPYRIGHT_YEAR) \ 25 | --word-wrap $(COPYRIGHT_WORD_WRAP) \ 26 | --output-dir $(COPYRIGHT_OUTPUT_DIR) 27 | 28 | add-copyright: 29 | $(COPYRIGHT_CMD) \ 30 | --license $(COPYRIGHT_LICENSE) \ 31 | --add-path $(COPYRIGHT_PATHS) \ 32 | --guess-extension \ 33 | --copyright-holder '$(COPYRIGHT_HOLDER)' \ 34 | --copyright-software '$(COPYRIGHT_SOFTWARE)' \ 35 | --copyright-software-description '$(COPYRIGHT_SOFTWARE_DESCRIPTION)' \ 36 | --copyright-year $(COPYRIGHT_YEAR) \ 37 | --word-wrap $(COPYRIGHT_WORD_WRAP) \ 38 | --output-dir $(COPYRIGHT_OUTPUT_DIR) 39 | 40 | 41 | bump: 42 | gem bump 43 | 44 | release: 45 | rake release 46 | -------------------------------------------------------------------------------- /licenses/BSD-4-CLAUSE.erb: -------------------------------------------------------------------------------- 1 | Copyright (c) <%=copyright_years.join(', ')%> <%=copyright_holders.join(', ')%> 2 | All rights reserved. 3 | 4 | Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 5 | 6 | * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 7 | * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 8 | * All advertising materials mentioning features or use of this software must display the following acknowledgement: This product includes software developed by %ORGANIZATION% and its contributors. 9 | * Neither the name of %ORGANIZATION% nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 10 | 11 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 12 | -------------------------------------------------------------------------------- /contrib/syntax.yml: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright Header - A utility to manipulate copyright headers on source code files 3 | # Copyright (C) 2012-2017 Erik Osterman 4 | # 5 | # This file is part of Copyright Header. 6 | # 7 | # Copyright Header is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # Copyright Header is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with Copyright Header. If not, see . 19 | # 20 | ruby: 21 | ext: ['.rb', '.rake'] 22 | after: ['^#!', '^#.*encoding:', '^#.*frozen_string_literal:'] 23 | comment: 24 | open: '\n#\n' 25 | close: '#\n' 26 | prefix: '# ' 27 | 28 | perl: 29 | ext: ['.pl'] 30 | after: ['^#!', '^#.*encoding:'] 31 | comment: 32 | open: '#\n' 33 | close: '#\n' 34 | prefix: '# ' 35 | 36 | # Support PEP 0263 comments: 37 | # coding= 38 | # -*- coding: -*- 39 | # vim: set fileencoding= : 40 | python: 41 | ext: ['.py'] 42 | after: ['^#!', '^#.*coding:', '^#.*coding=', '^#.*fileencoding='] 43 | comment: 44 | open: '\n' 45 | close: '\n' 46 | prefix: '# ' 47 | 48 | html: 49 | ext: ['.html', '.htm', '.xhtml'] 50 | comment: 51 | open: '\n' 53 | prefix: ' ' 54 | 55 | php: 56 | ext: ['.php'] 57 | after: [ '^#!' ] 58 | comment: 59 | open: '\n' 61 | prefix: ' * ' 62 | 63 | javacript: 64 | ext: ['.js', '.jsx'] 65 | comment: 66 | open: '/*\n' 67 | close: ' */\n\n' 68 | prefix: ' * ' 69 | 70 | qml: 71 | ext: ['.qml'] 72 | comment: 73 | open: '/*\n' 74 | close: ' */\n\n' 75 | prefix: ' * ' 76 | 77 | qmake_project: 78 | ext: ['.pro'] 79 | comment: 80 | open: '#\n' 81 | close: '#\n' 82 | prefix: '# ' 83 | 84 | css: 85 | ext: ['.css'] 86 | comment: 87 | open: '/*\n' 88 | close: ' */\n\n' 89 | prefix: ' * ' 90 | 91 | c: 92 | ext: ['.c', '.h'] 93 | comment: 94 | open: '/*' 95 | close: ' */\n\n' 96 | prefix: ' * ' 97 | 98 | cpp: 99 | ext: ['.cpp', '.hpp', '.cc', '.hh'] 100 | comment: 101 | open: '//\n' 102 | close: '//\n\n' 103 | prefix: '// ' 104 | 105 | java: 106 | ext: ['.java'] 107 | comment: 108 | open: '/*\n' 109 | close: ' */\n\n' 110 | prefix: ' * ' 111 | 112 | kotlin: 113 | ext: ['.kt'] 114 | comment: 115 | open: '/*\n' 116 | clone: ' */\n\n' 117 | prefix: ' * ' 118 | 119 | golang: 120 | ext: ['.go'] 121 | comment: 122 | open: '/*\n' 123 | close: ' */\n\n' 124 | prefix: ' * ' 125 | 126 | groovy: 127 | ext: ['.groovy'] 128 | comment: 129 | open: '/*\n' 130 | close: ' */\n\n' 131 | prefix: ' * ' 132 | 133 | haml: 134 | ext: ['.haml', '.hamlc'] 135 | comment: 136 | open: '-#\n' 137 | close: '-#\n' 138 | prefix: '-# ' 139 | 140 | coffee: 141 | ext: ['.coffee'] 142 | comment: 143 | open: '###\n' 144 | close: '###\n' 145 | prefix: '' 146 | 147 | # M4 macro language, use #, not dnl 148 | m4: 149 | ext: ['.m4'] 150 | comment: 151 | open: '#\n' 152 | close: '#\n' 153 | prefix: '# ' 154 | 155 | # Most shells, really 156 | shell: 157 | ext: ['.sh'] 158 | after: ['^#!'] 159 | comment: 160 | open: '#\n' 161 | close: '#\n' 162 | prefix: '# ' 163 | 164 | # Use "-- " to make sure e.g. MySQL understands it 165 | sql: 166 | ext: ['.sql'] 167 | comment: 168 | open: '-- \n' 169 | close: '-- \n' 170 | prefix: '-- ' 171 | 172 | # XML is *not* the same as HTML, and the comments need to go after a 173 | # preprocessing directive, if present. 174 | # FIXME: only supports single line directives 175 | xml: 176 | ext: ['.xml', '.xsd', '.mxml'] 177 | after: ['^<\?'] 178 | comment: 179 | open: '\n' 181 | prefix: ' ' 182 | 183 | yaml: 184 | ext: ['.yml', '.yaml'] 185 | comment: 186 | open: '#\n' 187 | close: '#\n' 188 | prefix: '# ' 189 | 190 | action_script: 191 | ext: ['.as'] 192 | comment: 193 | open: '//\n' 194 | close: '//\n\n' 195 | prefix: '// ' 196 | 197 | sass: 198 | ext: ['.sass', '.scss'] 199 | comment: 200 | open: '/*\n' 201 | close: ' */\n\n' 202 | prefix: ' * ' 203 | 204 | verilog: 205 | ext: ['.v', '.sv'] 206 | comment: 207 | open: '//\n' 208 | close: '//\n\n' 209 | prefix: '// ' 210 | 211 | vhdl: 212 | ext: ['.vhd'] 213 | comment: 214 | open: '--\n' 215 | close: '--\n\n' 216 | prefix: '-- ' 217 | 218 | elm: 219 | ext: ['.elm'] 220 | comment: 221 | open: '{-\n' 222 | close: '-}\n\n' 223 | prefix: ' ' 224 | 225 | swift: 226 | ext: ['.swift'] 227 | comment: 228 | open: '/*\n' 229 | close: ' */\n\n' 230 | prefix: ' * ' 231 | 232 | rust: 233 | ext: ['.rs'] 234 | comment: 235 | open: '/*\n' 236 | close: ' */\n\n' 237 | prefix: ' * ' 238 | # Conf files i.e. apache config, splunk.conf files 239 | conf: 240 | ext: ['.conf'] 241 | comment: 242 | open: '#\n' 243 | close: '#\n' 244 | prefix: '# ' 245 | -------------------------------------------------------------------------------- /lib/copyright_header/command_line.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright Header - A utility to manipulate copyright headers on source code files 3 | # Copyright (C) 2012-2016 Erik Osterman 4 | # 5 | # This file is part of Copyright Header. 6 | # 7 | # Copyright Header is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # Copyright Header is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with Copyright Header. If not, see . 19 | # 20 | require 'optparse' 21 | 22 | module CopyrightHeader 23 | class MissingArgumentException < Exception; end 24 | class AmbiguousArgumentException < Exception; end 25 | 26 | class CommandLine 27 | attr_accessor :options, :parser, :optparse 28 | def initialize(options = {}) 29 | begin 30 | @options = options 31 | @options[:base_path] ||= File.expand_path File.dirname(__FILE__) + "/../../" 32 | @optparse = OptionParser.new do |opts| 33 | opts.banner = "Usage: #{$0} options [file]" 34 | 35 | @options[:dry_run] ||= false 36 | opts.on( '-n', '--dry-run', 'Output the parsed files to STDOUT' ) do 37 | @options[:dry_run] = true 38 | end 39 | 40 | opts.on( '-o', '--output-dir DIR', 'Use DIR as output directory') do |dir| 41 | @options[:output_dir] = dir.gsub(/\/+$/, '') 42 | end 43 | 44 | opts.on( '--license-file FILE', 'Use FILE as header (instead of using --license argument)' ) do|file| 45 | @options[:license_file] = file 46 | end 47 | 48 | opts.on( '--license [' + Dir.glob(@options[:base_path] + '/licenses/*').map { |f| File.basename(f, '.erb') }.join('|') + ']', 'Use LICENSE as header' ) do|license| 49 | @options[:license] = license 50 | end 51 | 52 | opts.on( '--copyright-software NAME', 'The common name for this piece of software (e.g. "Copyright Header")' ) do|name| 53 | @options[:copyright_software] = name 54 | end 55 | 56 | opts.on( '--copyright-software-description DESC', 'The detailed description for this piece of software (e.g. "A utility to manipulate copyright headers on source code files")' ) do|desc| 57 | @options[:copyright_software_description] = desc 58 | end 59 | 60 | @options[:copyright_holders] ||= [] 61 | opts.on( '--copyright-holder NAME', 'The legal owner of the copyright for the software. (e.g. "Erik Osterman "). Repeat argument for multiple names.' ) do|name| 62 | @options[:copyright_holders] << name 63 | end 64 | 65 | @options[:copyright_years] ||= [] 66 | opts.on( '--copyright-year YEAR', 'The years for which the copyright exists (e.g. "2012"). Repeat argument for multiple years.' ) do|year| 67 | @options[:copyright_years] << year 68 | end 69 | 70 | @options[:word_wrap] ||= 80 71 | opts.on( '-w', '--word-wrap LEN', 'Maximum number of characters per line for license (default: 80)' ) do |len| 72 | @options[:word_wrap] = len.to_i 73 | end 74 | 75 | opts.on( '-a', '--add-path PATH', 'Recursively insert header in all files found in path (allows multiple paths separated by platform path-separator "' + File::PATH_SEPARATOR + '")' ) do |path| 76 | @options[:add_path] = path 77 | end 78 | 79 | opts.on( '-r', '--remove-path PATH', 'Recursively remove header in all files found in path (allows multiple paths separated by platform path-separator "' + File::PATH_SEPARATOR + '")' ) do |path| 80 | @options[:remove_path] = path 81 | end 82 | 83 | @options[:guess_extension] ||= false 84 | opts.on( '-g', '--guess-extension', 'Use the GitHub Linguist gem to guess the extension of the source code when no extension can be determined (experimental).' ) do 85 | @options[:guess_extension] = true 86 | end 87 | 88 | @options[:syntax] ||= @options[:base_path] + '/contrib/syntax.yml' 89 | opts.on( '-c', '--syntax FILE', 'Syntax configuration file' ) do |path| 90 | @options[:syntax] = path 91 | end 92 | 93 | opts.on( '-V', '--version', 'Display version information' ) do 94 | STDERR.puts "CopyrightHeader #{CopyrightHeader::VERSION}", 95 | "Copyright (C) 2012 Erik Osterman ", 96 | "License GPLv3+: GNU GPL version 3 or later ", 97 | "This is free software: you are free to change and redistribute it.", 98 | "There is NO WARRANTY, to the extent permitted by law." 99 | exit 100 | end 101 | 102 | opts.on( '-h', '--help', 'Display this screen' ) do 103 | puts opts 104 | exit 105 | end 106 | end 107 | 108 | @optparse.parse! 109 | 110 | unless @options[:license].nil? 111 | unless @options[:license_file].nil? 112 | raise AmbiguousArgumentException.new("Cannot pass both --license and --license-file arguments") 113 | end 114 | # get the license_file from the shiped files 115 | @options[:license_file] ||= @options[:base_path] + '/licenses/' + @options[:license] + '.erb' 116 | end 117 | 118 | unless @options.has_key?(:license_file) 119 | raise MissingArgumentException.new("Missing --license or --license-file argument") 120 | end 121 | 122 | unless File.file?(@options[:license_file]) 123 | raise MissingArgumentException.new("Invalid --license or --license-file argument. Cannot open #{@options[:license_file]}") 124 | end 125 | 126 | if @options[:license] 127 | raise MissingArgumentException.new("Missing --copyright-software argument") if @options[:copyright_software].nil? 128 | raise MissingArgumentException.new("Missing --copyright-software-description argument") if @options[:copyright_software_description].nil? 129 | raise MissingArgumentException.new("Missing --copyright-holder argument") unless @options[:copyright_holders].length > 0 130 | raise MissingArgumentException.new("Missing --copyright-year argument") unless @options[:copyright_years].length > 0 131 | end 132 | rescue MissingArgumentException => e 133 | STDERR.puts e.message, @optparse 134 | exit (1) 135 | end 136 | end 137 | 138 | def execute 139 | STDERR.puts "-- DRY RUN --" if @options[:dry_run] 140 | @parser = CopyrightHeader::Parser.new(@options) 141 | @parser.execute 142 | end 143 | end 144 | end -------------------------------------------------------------------------------- /README.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | # 3 | # This is the canonical configuration for the `README.md` 4 | # Run `make readme` to rebuild the `README.md` 5 | # 6 | 7 | # Name of this project 8 | name: copyright-header 9 | 10 | # Logo for this project 11 | #logo: docs/logo.png 12 | 13 | # License of this project 14 | license: "GPL3" 15 | 16 | # Canonical GitHub repo 17 | github_repo: cloudposse/copyright-header 18 | 19 | # Badges to display 20 | badges: 21 | - name: "Build Status" 22 | image: "https://travis-ci.org/cloudposse/copyright-header.svg?branch=master" 23 | url: "https://travis-ci.org/cloudposse/copyright-header" 24 | - name: "Latest Release" 25 | image: "https://img.shields.io/github/release/cloudposse/copyright-header.svg" 26 | url: "https://github.com/cloudposse/copyright-header/releases" 27 | - name: "Slack Community" 28 | image: "https://slack.cloudposse.com/badge.svg" 29 | url: "https://slack.cloudposse.com" 30 | 31 | # Short description of this project 32 | description: |- 33 | Copyright Header is a utility to manipulate licenses on source code. 34 | 35 | Features 36 | -------- 37 | 38 | * Add/remove a copyright headers recursively on source files 39 | * Customize the syntax configuration for how to write out comments 40 | * Built-in support for GPL3 and MIT licenses 41 | * Supports custom licenes with `--license-file` argument 42 | * ERB template support 43 | 44 | Caveats 45 | ------- 46 | * Will only remove headers to files that have exactly the same header as the one we added 47 | * Will only add headers to files which do not contain the case-sensitive pattern `/[Cc]opyright|[Lc]icense/` in the first `N` lines 48 | * Will not properly format arguments that contain new-line ("`\n`") characters. 49 | 50 | Requirements 51 | ------------ 52 | 53 | * Ruby 1.9.2 (supported version, might work with older rubies but not guaranteed) 54 | 55 | Installation 56 | ------------ 57 | 58 | Install Copyright Header from RubyForge: 59 | 60 | gem install copyright-header 61 | 62 | # How to use this project 63 | usage: |- 64 | Full list of supported arguments: 65 | 66 | Usage: copyright-header options [file] 67 | -n, --dry-run Output the parsed files to STDOUT 68 | -o, --output-dir DIR Use DIR as output directory 69 | --license-file FILE Use FILE as header (instead of using --license argument) 70 | --license [AGPL3|ASL2|BSD-2-CLAUSE|BSD-3-CLAUSE|BSD-4-CLAUSE|GPL3|MIT] 71 | Use LICENSE as header 72 | --copyright-software NAME The common name for this piece of software (e.g. "Copyright Header") 73 | --copyright-software-description DESC 74 | The detailed description for this piece of software (e.g. "A utility to manipulate copyright headers on source code files") 75 | --copyright-holder NAME The legal owner of the copyright for the software. (e.g. "Erik Osterman "). Repeat argument for multiple names. 76 | --copyright-year YEAR The years for which the copyright exists (e.g. "2012-2017"). Repeat argument for multiple years. 77 | -w, --word-wrap LEN Maximum number of characters per line for license (default: 80) 78 | -a, --add-path PATH Recursively insert header in all files found in path (allows multiple paths separated by platform path-separator ":") 79 | -r, --remove-path PATH Recursively remove header in all files found in path (allows multiple paths separated by platform path-separator ":") 80 | -g, --guess-extension Use the GitHub Linguist gem to guess the extension of the source code when no extension can be determined (experimental). 81 | -c, --syntax FILE Syntax configuration file 82 | -V, --version Display version information 83 | -h, --help Display this screen 84 | 85 | # Example usage 86 | 87 | examples: |- 88 | Discover available parameters by passing the `--help` argument 89 | 90 | copyright-header --help 91 | 92 | Add a GPL3 License header to a file: 93 | 94 | copyright-header --add-path /tmp/test.rb \ 95 | --license GPL3 \ 96 | --copyright-holder 'Joe Shmoe' \ 97 | --copyright-software 'Example Software' \ 98 | --copyright-software-description "This is the description of the software." \ 99 | --copyright-year 2012-2017 \ 100 | --output-dir /tmp \ 101 | --dry-run 102 | 103 | Remove the header created in the previous step (without --dry-run argument): 104 | 105 | copyright-header --remove-path /tmp/test.rb \ 106 | --license GPL3 \ 107 | --copyright-holder 'Joe Shmoe' \ 108 | --copyright-software 'Example Software' \ 109 | --copyright-software-description 'This is the description of the software.' \ 110 | --copyright-year 2012-2017 \ 111 | --output-dir /tmp \ 112 | --dry-run 113 | 114 | Command used to generate copyright headers for this script: 115 | 116 | copyright-header --license GPL3 \ 117 | --add-path lib/:bin/ \ 118 | --guess-extension \ 119 | --copyright-holder 'Erik Osterman ' \ 120 | --copyright-software 'Copyright Header' \ 121 | --copyright-software-description "A utility to manipulate copyright headers on source code files" \ 122 | --copyright-year 2012-2017 \ 123 | --word-wrap 100 \ 124 | --output-dir ./ 125 | 126 | 127 | Paths can be either files or directories. It will recursively traverse the directory tree ignoring all dot files. 128 | 129 | You can specify an alternative syntax configuration file using the `--syntax` argument. 130 | 131 | ## Rake 132 | 133 | The above example can be performed as rake task inside a Rakefile: 134 | 135 | task :headers do 136 | require 'rubygems' 137 | require 'copyright_header' 138 | 139 | args = { 140 | :license => 'GPL3', 141 | :copyright_software => 'Copyright Header', 142 | :copyright_software_description => "A utility to manipulate copyright headers on source code files", 143 | :copyright_holders => ['Erik Osterman '], 144 | :copyright_years => ['2012-2017'], 145 | :add_path => 'lib', 146 | :output_dir => '.' 147 | } 148 | 149 | command_line = CopyrightHeader::CommandLine.new( args ) 150 | command_line.execute 151 | end 152 | 153 | ## Docker 154 | 155 | ``` 156 | docker run --rm --volume `pwd`:/usr/src/ osterman/copyright-header:latest \ 157 | --license GPL3 \ 158 | --add-path . \ 159 | --guess-extension \ 160 | --copyright-holder 'Erik Osteman ' \ 161 | --copyright-software 'Copyright Header' \ 162 | --copyright-software-description 'A utility to manipulate copyright headers on source code files' \ 163 | --copyright-year 2012-2017 \ 164 | --word-wrap 100 \ 165 | --output-dir /usr/src/ 166 | ``` 167 | 168 | ## Make 169 | 170 | Here is how we typically use it in our [`Makefile`](Makefile). 171 | 172 | Check out the Cloud Posse [`build-harness`](https://github.com/cloudposse/build-harness/) for other neat tricks. 173 | 174 | # Example goes here... 175 | 176 | # How to get started quickly 177 | #quickstart: |- 178 | # Here's how to get started... 179 | 180 | # Contributors to this project 181 | contributors: 182 | - name: "Erik Osterman" 183 | github: "osterman" 184 | - name: "Leo O'Donnell" 185 | github: "leopoldodonnell" 186 | - name: "Christian Meier" 187 | github: "mkristian" 188 | - name: "Gabriel de Perthuis" 189 | github: "g2p" 190 | - name: "Thomas Russell Murphy" 191 | github: "thomasrussellmurphy" 192 | - name: "Kongqun Yang" 193 | github: "kqyang" 194 | - name: "Vincent Billey" 195 | github: "Fenntasy" 196 | - name: "arximboldi" 197 | github: "arximboldi" 198 | - name: "David" 199 | github: "TAGC" 200 | - name: "Rafał Rzepecki" 201 | github: "dividedmind" 202 | - name: "David Yip" 203 | github: "yipdw" 204 | - name: "Daniel Freedman" 205 | github: "azakus" 206 | - name: "Mitch Souders" 207 | github: "crzysdrs" 208 | - name: "Mads Bondo Dydensborg" 209 | github: "mbd-dbc-dk" 210 | - name: "Psy-Q" 211 | github: "psy-q" 212 | - name: "Bryan" 213 | github: "bstopp" 214 | - name: "Colin Dean" 215 | github: "colindean" 216 | - name: "Wahaj Shamim" 217 | github: "wshamim" 218 | - name: "halo" 219 | github: "halo" 220 | - name: "Lloyd Dewolf" 221 | github: "lloydde" -------------------------------------------------------------------------------- /lib/copyright_header/parser.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright Header - A utility to manipulate copyright headers on source code files 3 | # Copyright (C) 2012-2016 Erik Osterman 4 | # 5 | # This file is part of Copyright Header. 6 | # 7 | # Copyright Header is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # Copyright Header is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with Copyright Header. If not, see . 19 | # 20 | require 'fileutils' 21 | require 'yaml' 22 | require 'erb' 23 | require 'ostruct' 24 | require 'linguist' 25 | 26 | module CopyrightHeader 27 | class FileNotFoundException < Exception; end 28 | class ExistingLicenseException < Exception; end 29 | 30 | class License 31 | @lines = [] 32 | def initialize(options) 33 | @options = options 34 | @lines = load_template.split(/\n/).map { |line| line += "\n" } 35 | end 36 | 37 | def word_wrap(text, max_width = nil) 38 | max_width ||= @options[:word_wrap] 39 | text.gsub(/(.{1,#{max_width}})(\s|\Z)/, "\\1\n") 40 | end 41 | 42 | def load_template 43 | if File.exists?(@options[:license_file]) 44 | template = ::ERB.new File.new(@options[:license_file]).read, 0, '%' 45 | license = template.result(OpenStruct.new(@options).instance_eval { binding }) 46 | license = word_wrap(license) 47 | license 48 | else 49 | raise FileNotFoundException.new("Unable to open #{file}") 50 | end 51 | end 52 | 53 | def format(comment_open = nil, comment_close = nil, comment_prefix = nil) 54 | comment_open ||= '' 55 | comment_close ||= '' 56 | comment_prefix ||= '' 57 | license = comment_open + @lines.map { |line| (comment_prefix + line).gsub(/\s+\n$/, "\n") }.join() + comment_close 58 | license.gsub!(/\\n/, "\n") 59 | license 60 | end 61 | end 62 | 63 | class Header 64 | @file = nil 65 | @contents = nil 66 | @config = nil 67 | 68 | def initialize(file, config) 69 | @file = file 70 | @contents = File.read(@file) 71 | @config = config 72 | end 73 | 74 | def format(license) 75 | license.format(@config[:comment]['open'], @config[:comment]['close'], @config[:comment]['prefix']) 76 | end 77 | 78 | def add(license) 79 | if has_copyright? 80 | raise ExistingLicenseException.new("detected existing license") 81 | end 82 | 83 | copyright = self.format(license) 84 | if copyright.nil? 85 | STDERR.puts "Copyright is nil" 86 | return nil 87 | end 88 | 89 | text = "" 90 | if @config.has_key?(:after) && @config[:after].instance_of?(Array) 91 | copyright_written = false 92 | lines = @contents.split(/\n/, -1) 93 | head = lines.shift(10) 94 | while(head.size > 0) 95 | line = head.shift 96 | text += line + "\n" 97 | @config[:after].each do |regex| 98 | pattern = Regexp.new(regex) 99 | if pattern.match(line) 100 | text += copyright 101 | copyright_written = true 102 | break 103 | end 104 | end 105 | end 106 | if copyright_written 107 | text += lines.join("\n") 108 | else 109 | text = copyright + text + lines.join("\n") 110 | end 111 | else 112 | # Simply prepend text 113 | text = copyright + @contents 114 | end 115 | return text 116 | end 117 | 118 | def remove(license) 119 | if has_copyright? 120 | text = self.format(license) 121 | # Due to editors messing with whitespace, we'll make this more of a fuzzy match and use \s to match whitespace 122 | pattern = Regexp.escape(text).gsub(/\\[ n]/, '\s*').gsub(/\\s*$/, '\s') 123 | exp = Regexp.new(pattern) 124 | @contents.gsub!(exp, '') 125 | @contents 126 | else 127 | STDERR.puts "SKIP #{@file}; copyright not detected" 128 | return nil 129 | end 130 | end 131 | 132 | def has_copyright?(lines = 10) 133 | @contents.split(/\n/)[0..lines].select { |line| line =~ /(?!class\s+)([Cc]opyright|[Ll]icense)\s/ }.length > 0 134 | end 135 | end 136 | 137 | class Syntax 138 | attr_accessor :guess_extension 139 | 140 | def initialize(config, guess_extension = false) 141 | @guess_extension = guess_extension 142 | @config = {} 143 | syntax = YAML.load_file(config) 144 | syntax.each_value do |format| 145 | format['ext'].each do |ext| 146 | @config[ext] = { 147 | :before => format['before'], 148 | :after => format['after'], 149 | :comment => format['comment'] 150 | } 151 | end 152 | end 153 | end 154 | 155 | def ext(file) 156 | extension = File.extname(file) 157 | if @guess_extension && (extension.nil? || extension.empty?) 158 | extension = Linguist::FileBlob.new(file).language.extensions.first 159 | end 160 | return extension 161 | end 162 | 163 | def supported?(file) 164 | @config.has_key? ext(file) 165 | end 166 | 167 | def header(file) 168 | Header.new(file, @config[ext(file)]) 169 | end 170 | end 171 | 172 | class Parser 173 | attr_accessor :options 174 | @syntax = nil 175 | @license = nil 176 | def initialize(options = {}) 177 | @options = options 178 | @exclude = [ /^LICENSE(|\.txt)$/i, /^holders(|\.txt)$/i, /^README/, /^\./] 179 | @license = License.new(:license_file => @options[:license_file], 180 | :copyright_software => @options[:copyright_software], 181 | :copyright_software_description => @options[:copyright_software_description], 182 | :copyright_years => @options[:copyright_years], 183 | :copyright_holders => @options[:copyright_holders], 184 | :word_wrap => @options[:word_wrap]) 185 | @syntax = Syntax.new(@options[:syntax], @options[:guess_extension]) 186 | end 187 | 188 | def execute 189 | if @options.has_key?(:add_path) 190 | @options[:add_path].split(File::PATH_SEPARATOR).each { |path| add(path) } 191 | end 192 | 193 | if @options.has_key?(:remove_path) 194 | @options[:remove_path].split(File::PATH_SEPARATOR).each { |path| remove(path) } 195 | end 196 | end 197 | 198 | def transform(method, path) 199 | paths = [] 200 | if File.file?(path) 201 | paths << path 202 | else 203 | paths << Dir.glob("#{path}/**/*") 204 | end 205 | 206 | paths.flatten! 207 | 208 | paths.each do |path| 209 | begin 210 | if File.file?(path) 211 | if File.basename(path).match(Regexp.union(@exclude)) 212 | STDERR.puts "SKIP #{path}; excluded" 213 | next 214 | end 215 | elsif File.directory?(path) 216 | next 217 | else 218 | STDERR.puts "SKIP #{path}; not file" 219 | next 220 | end 221 | 222 | if @syntax.supported?(path) 223 | header = @syntax.header(path) 224 | contents = header.send(method, @license) 225 | if contents.nil? 226 | STDERR.puts "SKIP #{path}; failed to generate license" 227 | else 228 | write(path, contents) 229 | end 230 | else 231 | STDERR.puts "SKIP #{path}; unsupported #{@syntax.ext(path)}" 232 | end 233 | rescue Exception => e 234 | STDERR.puts "SKIP #{path}; exception=#{e.message}" 235 | end 236 | end 237 | end 238 | 239 | # Add copyright header recursively 240 | def add(dir) 241 | transform(:add, dir) 242 | end 243 | 244 | # Remove copyright header recursively 245 | def remove(dir) 246 | transform(:remove, dir) 247 | end 248 | 249 | def write(file, contents) 250 | if @options[:dry_run] 251 | STDERR.puts "UPDATE #{file} [dry-run]" 252 | STDERR.puts contents 253 | elsif @options[:output_dir].nil? 254 | STDERR.puts "UPDATE #{file} [no output-dir]" 255 | STDERR.puts contents 256 | else 257 | dir = "#{@options[:output_dir]}/#{File.dirname(file).gsub(/^\/+/, '')}" 258 | STDERR.puts "UPDATE #{file} [output-dir #{dir}]" 259 | FileUtils.mkpath dir unless File.directory?(dir) 260 | output_path = @options[:output_dir] + "/" + file 261 | f =File.new(output_path, 'w') 262 | f.write(contents) 263 | f.close 264 | end 265 | end 266 | end 267 | end 268 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [![Cloud Posse](https://cloudposse.com/logo-300x69.svg)](https://cloudposse.com) 4 | 5 | # copyright-header [![Build Status](https://travis-ci.org/cloudposse/copyright-header.svg?branch=master)](https://travis-ci.org/cloudposse/copyright-header) [![Latest Release](https://img.shields.io/github/release/cloudposse/copyright-header.svg)](https://github.com/cloudposse/copyright-header/releases) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com) 6 | 7 | 8 | Copyright Header is a utility to manipulate licenses on source code. 9 | 10 | Features 11 | -------- 12 | 13 | * Add/remove a copyright headers recursively on source files 14 | * Customize the syntax configuration for how to write out comments 15 | * Built-in support for GPL3 and MIT licenses 16 | * Supports custom licenes with `--license-file` argument 17 | * ERB template support 18 | 19 | Caveats 20 | ------- 21 | * Will only remove headers to files that have exactly the same header as the one we added 22 | * Will only add headers to files which do not contain the case-sensitive pattern `/[Cc]opyright|[Lc]icense/` in the first `N` lines 23 | * Will not properly format arguments that contain new-line ("`\n`") characters. 24 | 25 | Requirements 26 | ------------ 27 | 28 | * Ruby 1.9.2 (supported version, might work with older rubies but not guaranteed) 29 | 30 | Installation 31 | ------------ 32 | 33 | Install Copyright Header from RubyForge: 34 | 35 | gem install copyright-header 36 | 37 | 38 | --- 39 | 40 | This project is part of our comprehensive ["SweetOps"](https://docs.cloudposse.com) approach towards DevOps. 41 | 42 | 43 | 44 | 45 | 46 | 47 | It's 100% Open Source and licensed under the [GNU General Public License](LICENSE). 48 | 49 | 50 | 51 | 52 | 53 | 54 | ## Usage 55 | 56 | Full list of supported arguments: 57 | 58 | Usage: copyright-header options [file] 59 | -n, --dry-run Output the parsed files to STDOUT 60 | -o, --output-dir DIR Use DIR as output directory 61 | --license-file FILE Use FILE as header (instead of using --license argument) 62 | --license [AGPL3|ASL2|BSD-2-CLAUSE|BSD-3-CLAUSE|BSD-4-CLAUSE|GPL3|MIT] 63 | Use LICENSE as header 64 | --copyright-software NAME The common name for this piece of software (e.g. "Copyright Header") 65 | --copyright-software-description DESC 66 | The detailed description for this piece of software (e.g. "A utility to manipulate copyright headers on source code files") 67 | --copyright-holder NAME The legal owner of the copyright for the software. (e.g. "Erik Osterman "). Repeat argument for multiple names. 68 | --copyright-year YEAR The years for which the copyright exists (e.g. "2012-2017"). Repeat argument for multiple years. 69 | -w, --word-wrap LEN Maximum number of characters per line for license (default: 80) 70 | -a, --add-path PATH Recursively insert header in all files found in path (allows multiple paths separated by platform path-separator ":") 71 | -r, --remove-path PATH Recursively remove header in all files found in path (allows multiple paths separated by platform path-separator ":") 72 | -g, --guess-extension Use the GitHub Linguist gem to guess the extension of the source code when no extension can be determined (experimental). 73 | -c, --syntax FILE Syntax configuration file 74 | -V, --version Display version information 75 | -h, --help Display this screen 76 | 77 | 78 | 79 | 80 | ## Examples 81 | 82 | Discover available parameters by passing the `--help` argument 83 | 84 | copyright-header --help 85 | 86 | Add a GPL3 License header to a file: 87 | 88 | copyright-header --add-path /tmp/test.rb \ 89 | --license GPL3 \ 90 | --copyright-holder 'Joe Shmoe' \ 91 | --copyright-software 'Example Software' \ 92 | --copyright-software-description "This is the description of the software." \ 93 | --copyright-year 2012-2017 \ 94 | --output-dir /tmp \ 95 | --dry-run 96 | 97 | Remove the header created in the previous step (without --dry-run argument): 98 | 99 | copyright-header --remove-path /tmp/test.rb \ 100 | --license GPL3 \ 101 | --copyright-holder 'Joe Shmoe' \ 102 | --copyright-software 'Example Software' \ 103 | --copyright-software-description 'This is the description of the software.' \ 104 | --copyright-year 2012-2017 \ 105 | --output-dir /tmp \ 106 | --dry-run 107 | 108 | Command used to generate copyright headers for this script: 109 | 110 | copyright-header --license GPL3 \ 111 | --add-path lib/:bin/ \ 112 | --guess-extension \ 113 | --copyright-holder 'Erik Osterman ' \ 114 | --copyright-software 'Copyright Header' \ 115 | --copyright-software-description "A utility to manipulate copyright headers on source code files" \ 116 | --copyright-year 2012-2017 \ 117 | --word-wrap 100 \ 118 | --output-dir ./ 119 | 120 | 121 | Paths can be either files or directories. It will recursively traverse the directory tree ignoring all dot files. 122 | 123 | You can specify an alternative syntax configuration file using the `--syntax` argument. 124 | 125 | ## Rake 126 | 127 | The above example can be performed as rake task inside a Rakefile: 128 | 129 | task :headers do 130 | require 'rubygems' 131 | require 'copyright_header' 132 | 133 | args = { 134 | :license => 'GPL3', 135 | :copyright_software => 'Copyright Header', 136 | :copyright_software_description => "A utility to manipulate copyright headers on source code files", 137 | :copyright_holders => ['Erik Osterman '], 138 | :copyright_years => ['2012-2017'], 139 | :add_path => 'lib', 140 | :output_dir => '.' 141 | } 142 | 143 | command_line = CopyrightHeader::CommandLine.new( args ) 144 | command_line.execute 145 | end 146 | 147 | ## Docker 148 | 149 | ``` 150 | docker run --rm --volume `pwd`:/usr/src/ osterman/copyright-header:latest \ 151 | --license GPL3 \ 152 | --add-path . \ 153 | --guess-extension \ 154 | --copyright-holder 'Erik Osteman ' \ 155 | --copyright-software 'Copyright Header' \ 156 | --copyright-software-description 'A utility to manipulate copyright headers on source code files' \ 157 | --copyright-year 2012-2017 \ 158 | --word-wrap 100 \ 159 | --output-dir /usr/src/ 160 | ``` 161 | 162 | ## Make 163 | 164 | Here is how we typically use it in our [`Makefile`](Makefile). 165 | 166 | Check out the Cloud Posse [`build-harness`](https://github.com/cloudposse/build-harness/) for other neat tricks. 167 | 168 | 169 | 170 | 171 | 172 | ## Help 173 | 174 | **Got a question?** 175 | 176 | File a GitHub [issue](https://github.com/cloudposse/copyright-header/issues), send us an [email][email] or join our [Slack Community][slack]. 177 | 178 | ## Commerical Support 179 | 180 | Work directly with our team of DevOps experts via email, slack, and video conferencing. 181 | 182 | We provide *commercial support* for all of our [Open Source][github] projects. As a *Dedicated Support* customer, you have access to our team of subject matter experts at a fraction of the cost of a fulltime engineer. 183 | 184 | [![E-Mail](https://img.shields.io/badge/email-hello@cloudposse.com-blue.svg)](mailto:hello@cloudposse.com) 185 | 186 | - **Questions.** We'll use a Shared Slack channel between your team and ours. 187 | - **Troubleshooting.** We'll help you triage why things aren't working. 188 | - **Code Reviews.** We'll review your Pull Requests and provide constructive feedback. 189 | - **Bug Fixes.** We'll rapidly work to fix any bugs in our projects. 190 | - **Build New Terraform Modules.** We'll develop original modules to provision infrastructure. 191 | - **Cloud Architecture.** We'll assist with your cloud strategy and design. 192 | - **Implementation.** We'll provide hands on support to implement our reference architectures. 193 | 194 | 195 | ## Community Forum 196 | 197 | Get access to our [Open Source Community Forum][slack] on Slack. It's **FREE** to join for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build *sweet* infrastructure. 198 | 199 | ## Contributing 200 | 201 | ### Bug Reports & Feature Requests 202 | 203 | Please use the [issue tracker](https://github.com/cloudposse/copyright-header/issues) to report any bugs or file feature requests. 204 | 205 | ### Developing 206 | 207 | If you are interested in being a contributor and want to get involved in developing this project or [help out](https://github.com/orgs/cloudposse/projects/3) with our other projects, we would love to hear from you! Shoot us an [email](mailto:hello@cloudposse.com). 208 | 209 | In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow. 210 | 211 | 1. **Fork** the repo on GitHub 212 | 2. **Clone** the project to your own machine 213 | 3. **Commit** changes to your own branch 214 | 4. **Push** your work back up to your fork 215 | 5. Submit a **Pull Request** so that we can review your changes 216 | 217 | **NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request! 218 | 219 | 220 | ## Copyright 221 | 222 | Copyright © 2017-2018 [Cloud Posse, LLC](https://cloudposse.com) 223 | 224 | 225 | 226 | 227 | 228 | 229 | 230 | 231 | 232 | 233 | ## License 234 | 235 | [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) 236 | 237 | GNU GENERAL PUBLIC LICENSE 238 | Version 3, 29 June 2007 239 | 240 | This program is free software: you can redistribute it and/or modify 241 | it under the terms of the GNU General Public License as published by 242 | the Free Software Foundation, either version 3 of the License, or 243 | (at your option) any later version. 244 | 245 | This program is distributed in the hope that it will be useful, 246 | but WITHOUT ANY WARRANTY; without even the implied warranty of 247 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 248 | GNU General Public License for more details. 249 | 250 | You should have received a copy of the GNU General Public License 251 | along with this program. If not, see . 252 | 253 | 254 | ## Trademarks 255 | 256 | All other trademarks referenced herein are the property of their respective owners. 257 | 258 | ## About 259 | 260 | This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know at 261 | 262 | [![Cloud Posse](https://cloudposse.com/logo-300x69.svg)](https://cloudposse.com) 263 | 264 | We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We love [Open Source Software](https://github.com/cloudposse/)! 265 | 266 | We offer paid support on all of our projects. 267 | 268 | Check out [our other projects][github], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation. 269 | 270 | [docs]: https://docs.cloudposse.com/ 271 | [website]: https://cloudposse.com/ 272 | [github]: https://github.com/cloudposse/ 273 | [jobs]: https://cloudposse.com/jobs/ 274 | [hire]: https://cloudposse.com/contact/ 275 | [slack]: https://slack.cloudposse.com/ 276 | [linkedin]: https://www.linkedin.com/company/cloudposse 277 | [twitter]: https://twitter.com/cloudposse/ 278 | [email]: mailto:hello@cloudposse.com 279 | 280 | 281 | ### Contributors 282 | 283 | | [![Erik Osterman][osterman_avatar]][osterman_homepage]
[Erik Osterman][osterman_homepage] | [![Leo O'Donnell][leopoldodonnell_avatar]][leopoldodonnell_homepage]
[Leo O'Donnell][leopoldodonnell_homepage] | [![Christian Meier][mkristian_avatar]][mkristian_homepage]
[Christian Meier][mkristian_homepage] | [![Gabriel de Perthuis][g2p_avatar]][g2p_homepage]
[Gabriel de Perthuis][g2p_homepage] | [![Thomas Russell Murphy][thomasrussellmurphy_avatar]][thomasrussellmurphy_homepage]
[Thomas Russell Murphy][thomasrussellmurphy_homepage] | [![Kongqun Yang][kqyang_avatar]][kqyang_homepage]
[Kongqun Yang][kqyang_homepage] | [![Vincent Billey][Fenntasy_avatar]][Fenntasy_homepage]
[Vincent Billey][Fenntasy_homepage] | [![arximboldi][arximboldi_avatar]][arximboldi_homepage]
[arximboldi][arximboldi_homepage] | [![David][TAGC_avatar]][TAGC_homepage]
[David][TAGC_homepage] | [![Rafał Rzepecki][dividedmind_avatar]][dividedmind_homepage]
[Rafał Rzepecki][dividedmind_homepage] | [![David Yip][yipdw_avatar]][yipdw_homepage]
[David Yip][yipdw_homepage] | [![Daniel Freedman][azakus_avatar]][azakus_homepage]
[Daniel Freedman][azakus_homepage] | [![Mitch Souders][crzysdrs_avatar]][crzysdrs_homepage]
[Mitch Souders][crzysdrs_homepage] | [![Mads Bondo Dydensborg][mbd-dbc-dk_avatar]][mbd-dbc-dk_homepage]
[Mads Bondo Dydensborg][mbd-dbc-dk_homepage] | [![Psy-Q][psy-q_avatar]][psy-q_homepage]
[Psy-Q][psy-q_homepage] | [![Bryan][bstopp_avatar]][bstopp_homepage]
[Bryan][bstopp_homepage] | [![Colin Dean][colindean_avatar]][colindean_homepage]
[Colin Dean][colindean_homepage] | [![Wahaj Shamim][wshamim_avatar]][wshamim_homepage]
[Wahaj Shamim][wshamim_homepage] | [![halo][halo_avatar]][halo_homepage]
[halo][halo_homepage] | [![Lloyd Dewolf][lloydde_avatar]][lloydde_homepage]
[Lloyd Dewolf][lloydde_homepage] | 284 | |---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| 285 | 286 | [osterman_homepage]: https://github.com/osterman 287 | [osterman_avatar]: https://github.com/osterman.png?size=150 288 | [leopoldodonnell_homepage]: https://github.com/leopoldodonnell 289 | [leopoldodonnell_avatar]: https://github.com/leopoldodonnell.png?size=150 290 | [mkristian_homepage]: https://github.com/mkristian 291 | [mkristian_avatar]: https://github.com/mkristian.png?size=150 292 | [g2p_homepage]: https://github.com/g2p 293 | [g2p_avatar]: https://github.com/g2p.png?size=150 294 | [thomasrussellmurphy_homepage]: https://github.com/thomasrussellmurphy 295 | [thomasrussellmurphy_avatar]: https://github.com/thomasrussellmurphy.png?size=150 296 | [kqyang_homepage]: https://github.com/kqyang 297 | [kqyang_avatar]: https://github.com/kqyang.png?size=150 298 | [Fenntasy_homepage]: https://github.com/Fenntasy 299 | [Fenntasy_avatar]: https://github.com/Fenntasy.png?size=150 300 | [arximboldi_homepage]: https://github.com/arximboldi 301 | [arximboldi_avatar]: https://github.com/arximboldi.png?size=150 302 | [TAGC_homepage]: https://github.com/TAGC 303 | [TAGC_avatar]: https://github.com/TAGC.png?size=150 304 | [dividedmind_homepage]: https://github.com/dividedmind 305 | [dividedmind_avatar]: https://github.com/dividedmind.png?size=150 306 | [yipdw_homepage]: https://github.com/yipdw 307 | [yipdw_avatar]: https://github.com/yipdw.png?size=150 308 | [azakus_homepage]: https://github.com/azakus 309 | [azakus_avatar]: https://github.com/azakus.png?size=150 310 | [crzysdrs_homepage]: https://github.com/crzysdrs 311 | [crzysdrs_avatar]: https://github.com/crzysdrs.png?size=150 312 | [mbd-dbc-dk_homepage]: https://github.com/mbd-dbc-dk 313 | [mbd-dbc-dk_avatar]: https://github.com/mbd-dbc-dk.png?size=150 314 | [psy-q_homepage]: https://github.com/psy-q 315 | [psy-q_avatar]: https://github.com/psy-q.png?size=150 316 | [bstopp_homepage]: https://github.com/bstopp 317 | [bstopp_avatar]: https://github.com/bstopp.png?size=150 318 | [colindean_homepage]: https://github.com/colindean 319 | [colindean_avatar]: https://github.com/colindean.png?size=150 320 | [wshamim_homepage]: https://github.com/wshamim 321 | [wshamim_avatar]: https://github.com/wshamim.png?size=150 322 | [halo_homepage]: https://github.com/halo 323 | [halo_avatar]: https://github.com/halo.png?size=150 324 | [lloydde_homepage]: https://github.com/lloydde 325 | [lloydde_avatar]: https://github.com/lloydde.png?size=150 326 | 327 | 328 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------