Colony » Colony Scout

#!/usr/bin/python

# A simple script to add or delete the copyright notice on Colony files.

#  - del: Replaces the copyright info with a notice in all files

#  - add: Replaces the notice with copyright info

#

# Works recursively from the current directory.

#

# Don't commit files with the notice by mistake! I plan to use a git hook.

#

# Author: Alex Zirbel, a picky person.

import sys

import os

import string

copyright1 = """/**

 * Copyright (c) 2011 Colony Project

 * 

 * 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:

 * 

 * The above copyright notice and this permission notice shall be

 * included in all copies or substantial portions of the Software.

 * 

 * 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.

 */"""

# GIT_NOCOMMIT doesn't do anything unless you add a pre-commit hook.

notice1 = "/* Copyright 1 here. GIT_NOCOMMIT */"

copyright2 = """/**

 * The code in this package was developed using the structure of Willow

 * Garage's turtlesim package.  It was modified by the CMU Robotics Club

 * to be used as a simulator for the Colony Scout robot.

 *

 * All redistribution of this code is limited to the terms of Willow Garage's

 * licensing terms, as well as under permission from the CMU Robotics Club.

 * 

 * Copyright (c) 2011 Colony Project

 * 

 * 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:

 * 

 * The above copyright notice and this permission notice shall be

 * included in all copies or substantial portions of the Software.

 * 

 * Copyright (c) 2009, Willow Garage, Inc.

 * All rights reserved.

 * 

 * Redistribution and use in source and binary forms, with or without

 * modification, are permitted provided that the following conditions are met:

 * 

 *    Redistributions of source code must retain the above copyright

 *       notice, this list of conditions and the following disclaimer.

 *    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.

 *    Neither the name of the Willow Garage, Inc. nor the names of its

 *       contributors may be used to endorse or promote products derived from

 *       this software without specific prior written permission.

 * 

 * 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.

 */"""

# GIT_NOCOMMIT doesn't do anything unless you add a pre-commit hook.

notice2 = "/* Copyright 2 here. GIT_NOCOMMIT */"

# Check usage

if len(sys.argv) < 2 or (sys.argv[1] != "add" and sys.argv[1] != "del"):

    print "Usage:", sys.argv[0], "<add/del>"

    exit()

# All files recursively, from the current directory

for dirname, _, files in os.walk(os.getcwd()):

    for filename in files:

        # Don't edit the script itself!

        if filename == "copyrightme.py":

            continue

        # Edit in place by joining the path with the filename

        filename = os.path.join(dirname, filename)

        print filename

        new_contents = ""

        with open(filename, "r") as f:

            contents = "".join(f.readlines())

            if sys.argv[1] == "add":

                new_contents = string.replace(contents, notice1, copyright1)

                new_contents = string.replace(new_contents, notice2, copyright2)

            else:

                new_contents = string.replace(contents, copyright1, notice1)

                new_contents = string.replace(new_contents, copyright2, notice2)

        with open(filename, "w") as f:

            f.write(new_contents)