diff --git a/COPYING b/COPYING new file mode 100644 index 000000000..ecbc05937 --- /dev/null +++ b/COPYING @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. \ No newline at end of file diff --git a/bin/license_writer.py b/bin/license_writer.py new file mode 100755 index 000000000..f89984e9e --- /dev/null +++ b/bin/license_writer.py @@ -0,0 +1,268 @@ +#!/usr/bin/python +import sys +import logging +import optparse +import re +import os +import shutil +import time +from cStringIO import StringIO + +MAX_LINE_LENGTH = 80 + +FILE_TYPE_CONFIG = { + 'php': {'prefix': ' * ', + 'firstComment': '/**', + 'lastComment': ' */', + 'linesFirst': 0, + 'linesAfter': 0}, + 'js': {'prefix': ' * ', + 'firstComment': '/**', + 'lastComment': ' */', + 'linesFirst': 0, + 'linesAfter': 0} +} + +REPLACE_TOKENS = { + 'YEAR': time.strftime('%Y') +} + +SECTION_MARKER = re.compile(r'\{\{\{ICINGA_LICENSE_HEADER\}\}\}') + +LICENSE_DATA = None + +__version__ = '1.0' + +__LICENSE_STORE = {} + +__SUFFIX_MATCHER = None + + +class LogFormatter(logging.Formatter): + """Log formatter with color support which is enabled automaticallyby importing it.""" + + def __init__(self, *args, **kwargs): + logging.Formatter.__init__(self, *args, **kwargs) + self._color = sys.stderr.isatty() + if self._color: + self._colors = { + logging.DEBUG: ('\x1b[34m',), # Blue + logging.INFO: ('\x1b[32m',), # Green + logging.WARNING: ('\x1b[33m',), # Yellow + logging.ERROR: ('\x1b[31m',), # Red + logging.CRITICAL: ('\x1b[1m', '\x1b[31m'), # Bold, Red + } + self._footer = '\x1b[0m' + + def format(self, record): + formatted_message = logging.Formatter.format(self, record) + if self._color: + formatted_message = (''.join(self._colors.get(record.levelno)) + formatted_message + + len(self._colors.get(record.levelno)) * self._footer) + return formatted_message + + +def add_optparse_logging_options(parser, default_loglevel='DEBUG'): + """Add log levels to option parser""" + LOGLEVELS = ('INFO', 'WARNING', 'ERROR', 'CRITICAL', 'DEBUG') + parser.add_option('-v', '--verbose', dest='logging_level', default=default_loglevel, choices=LOGLEVELS, + help="Print verbose informational messages. One of %s. [default: %%default]" % ', '.join( + LOGLEVELS)) + + +def init_logging(loglevel): + """Initialize loglevels""" + channel = logging.StreamHandler() + channel.setFormatter(LogFormatter(fmt='%(asctime)-15s: %(message)s', datefmt='%Y-%m-%d %H:%M:%S')) + logging.getLogger().addHandler(channel) + logging.getLogger().setLevel(getattr(logging, loglevel)) + return logging.getLogger(__name__) + + +def init_optparse(): + """Initialize opt parser""" + parser = optparse.OptionParser(usage='%prog -d -L -B ', version='%%prog %s' % __version__) + + parser.add_option("-d", "--directory", action="append", type="string", dest="dir", + help="Directory, multiple switches possible") + + parser.add_option("-L", "--license", action="store", type="string", dest="license", + help="Path to license file") + + parser.add_option("-B", "--backup", action="store", type="string", dest="backup", + help="Backup suffix, e.g. '.BAK'") + add_optparse_logging_options(parser) + return parser + + +def match_file_suffix(file_name): + """Test if er have configuration for this file""" + global __SUFFIX_MATCHER + if __SUFFIX_MATCHER == None: + keys = FILE_TYPE_CONFIG.keys() + match = r'\.(' + '|'.join(keys) + r')$' + __SUFFIX_MATCHER = re.compile(match) + return __SUFFIX_MATCHER.search(file_name) + + +def load_files(dirs): + """Load all files found into an array""" + filelist = [] + for directory in dirs: + for root, subFolders, files in os.walk(directory): + for file_name in files: + if match_file_suffix(file_name): + filelist.append(os.path.join(root, file_name)) + return filelist + +def count_regex_matches(pattern, string): + """Counting regex matchings, e.g. tokens in a file""" + total = 0 + start = 0 + while True: + match_object = pattern.search(string, start) + if match_object is None: + return total + total += 1 + + start = match_object.start() + 1 + +def test_license_token(data, file_name): + """Test if we have a valid license token in a file""" + global SECTION_MARKER + c = count_regex_matches(SECTION_MARKER, data) + log = logging.getLogger(__name__) + + if c == 2: + return True + elif c == 0: + log.warn('No license token in file %s', file_name) + elif c < 2: + log.error('Incomplete license token in file %s', file_name) + else: + log.error('More that one license token in file %s', file_name) + + return False + +def get_license(type): + """Creates license data for a specific configuration""" + global FILE_TYPE_CONFIG + global LICENSE_DATA + global REPLACE_TOKENS + global __LICENSE_STORE + + try: + return __LICENSE_STORE[type] + except(KeyError): + config = FILE_TYPE_CONFIG[type] + license_data = [] + license_data.extend([''] * config['linesFirst']) + license_data.append(config['firstComment']) + for line in LICENSE_DATA.split('\n'): + license_data.append(config['prefix'] + line) + license_data.append(config['lastComment']) + license_data.extend([''] * config['linesAfter']) + __LICENSE_STORE[type] = '\n'.join(license_data) + __LICENSE_STORE[type] = __LICENSE_STORE[type] % REPLACE_TOKENS + + return __LICENSE_STORE[type] + +def read_file_content(file_name): + """Read file into a string""" + fhandle = open(file_name, 'r') + content = fhandle.read() + fhandle.close + return content + +def write_file_content(file_name, content): + """Write a string into a file""" + fhandle = open(file_name, 'w') + fhandle.write(content) + fhandle.close() + +def replace_text(org_data, license_data): + """Replace the license token in the string""" + shandle = StringIO(org_data) + out = '' + test = False + + while True: + line = shandle.readline() + + if line == '': + break + + if SECTION_MARKER.search(line) and test == False: + test = True + elif SECTION_MARKER.search(line) and test == True: + test = False + out += license_data + out += '\n' + elif test == True: + continue + + out += line + shandle.close() + return out + +def process_files(files, backup): + """Iterate over files and trigger reokacement""" + global FILE_TYPE_CONFIG + log = logging.getLogger(__name__) + for file_name in files: + data = read_file_content(file_name) + if test_license_token(data, file_name): + base, ext = os.path.splitext(file_name) + ext = ext[1:] + try: + config = FILE_TYPE_CONFIG[ext] + + license_data = get_license(ext) + new_data = replace_text(data, license_data) + + if data != new_data: + log.info('File changed: %s', file_name) + + if backup: + newfile = file_name + backup + log.info('Backup %s to %s', file_name, newfile) + shutil.copy(file_name, newfile) + + write_file_content(file_name, new_data) + + log.info('Written to file: %s', file_name) + + except (KeyError): + log.error('No header config for file type %s', ext) + continue + + + + +def main(): + """Main script entry point""" + global LICENSE_DATA + + parser = init_optparse() + (options, args) = parser.parse_args() + log = init_logging(options.logging_level) + + if options.dir is None or not len(options.dir) or not options.license: + log.error('--dir and --license are mandatory') + parser.print_help() + return (1) + + log.debug('starting') + + LICENSE_DATA = read_file_content(options.license) + + log.info('Scanning directories ...') + files = load_files(options.dir) + log.info('Got %d matching ones', len(files)) + + log.info('Processing files ...') + process_files(files, options.backup) + + +if __name__ == '__main__': + sys.exit(main()) \ No newline at end of file diff --git a/doc/LICENSEHEAD b/doc/LICENSEHEAD new file mode 100644 index 000000000..26805a3e5 --- /dev/null +++ b/doc/LICENSEHEAD @@ -0,0 +1,19 @@ +Icinga 2 Web - Head for multiple monitoring frontends +Copyright (C) %(YEAR)s Icinga Development Team + +This program is free software; you can redistribute it and/or +modify it under the terms of the GNU General Public License +as published by the Free Software Foundation; either version 2 +of the License, or (at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + +@copyright %(YEAR)s Icinga Development Team +@author Icinga Development Team \ No newline at end of file