Narzędzie do dodawania nagłówków licencji do plików źródłowych? [Zamknięte]

Szukam narzędzia, które zbiorczo doda nagłówek licencji do niektórych plików źródłowych, z których niektóre mają już nagłówek. Czy istnieje narzędzie, które wstawi nagłówek, jeśli jeszcze go nie ma?

Edycja: Celowo nie zaznaczam odpowiedzi na to pytanie, ponieważ odpowiedzi są w zasadzie wszystkie specyficzne dla środowiska i subiektywne

#!/bin/bash

for i in *.cc # or whatever other pattern...
do
  if ! grep -q Copyright $i
  then
    cat copyright.txt $i >$i.new && mv $i.new $i
  fi
done

Rozwiązanie Python, zmodyfikuj na własne potrzeby

Cechy:

• obsługuje nagłówki UTF (ważne dla większości IDE)
• rekurencyjnie aktualizuje wszystkie pliki w katalogu docelowym, przekazując podaną maskę (zmodyfikuj parametr .endswith dla maski plików Twojego języka (.c, .java, ..etc)
• możliwość nadpisania poprzedniego tekstu dotyczącego praw autorskich (w tym celu należy podać stary parametr dotyczący praw autorskich)
• opcjonalnie pomija katalogi podane w tablicy excludedir

-

# updates the copyright information for all .cs files
# usage: call recursive_traversal, with the following parameters
# parent directory, old copyright text content, new copyright text content

import os

excludedir = ["..\\Lib"]

def update_source(filename, oldcopyright, copyright):
    utfstr = chr(0xef)+chr(0xbb)+chr(0xbf)
    fdata = file(filename,"r+").read()
    isUTF = False
    if (fdata.startswith(utfstr)):
        isUTF = True
        fdata = fdata[3:]
    if (oldcopyright != None):
        if (fdata.startswith(oldcopyright)):
            fdata = fdata[len(oldcopyright):]
    if not (fdata.startswith(copyright)):
        print "updating "+filename
        fdata = copyright + fdata
        if (isUTF):
            file(filename,"w").write(utfstr+fdata)
        else:
            file(filename,"w").write(fdata)

def recursive_traversal(dir,  oldcopyright, copyright):
    global excludedir
    fns = os.listdir(dir)
    print "listing "+dir
    for fn in fns:
        fullfn = os.path.join(dir,fn)
        if (fullfn in excludedir):
            continue
        if (os.path.isdir(fullfn)):
            recursive_traversal(fullfn, oldcopyright, copyright)
        else:
            if (fullfn.endswith(".cs")):
                update_source(fullfn, oldcopyright, copyright)


oldcright = file("oldcr.txt","r+").read()
cright = file("copyrightText.txt","r+").read()
recursive_traversal("..", oldcright, cright)
exit()

Sprawdź RubyGem z nagłówkiem autorskim. Obsługuje pliki z rozszerzeniami kończącymi się na php, c, h, cpp, hpp, hh, rb, css, js, html. Może również dodawać i usuwać nagłówki.

Zainstaluj go, wpisując „ sudo gem install copyright-header”

Następnie możesz zrobić coś takiego:

copyright-header --license GPL3 \
  --add-path lib/ \
  --copyright-holder 'Dude1 <[email protected]>' \
  --copyright-holder 'Dude2 <[email protected]>' \
  --copyright-software 'Super Duper' \
  --copyright-software-description "A program that makes life easier" \
  --copyright-year 2012 \
  --copyright-year 2012 \
  --word-wrap 80 --output-dir ./

Obsługuje również pliki licencji niestandardowych przy użyciu argumentu --license-file.

Oto skrypt Bash, który załatwi sprawę, zakładając, że masz nagłówek licencji w pliku license.txt:

Plik addlicense.sh:

#!/bin/bash  
for x in $*; do  
head -$LICENSELEN $x | diff license.txt - || ( ( cat license.txt; echo; cat $x) > /tmp/file;  
mv /tmp/file $x )  
done  

Teraz uruchom to w swoim katalogu źródłowym:

export LICENSELEN=`wc -l license.txt | cut -f1 -d ' '`  
find . -type f \(-name \*.cpp -o -name \*.h \) -print0 | xargs -0 ./addlicense.sh  

Edycja: jeśli używasz eclipse, jest wtyczka

Napisałem prosty skrypt w Pythonie na podstawie odpowiedzi Silver Dragon. Potrzebowałem bardziej elastycznego rozwiązania, więc wymyśliłem to. Pozwala na rekurencyjne dodawanie pliku nagłówkowego do wszystkich plików w katalogu. Opcjonalnie możesz dodać wyrażenie regularne, do którego nazwy plików powinny pasować, oraz wyrażenie regularne, w którym nazwy katalogów powinny być zgodne, oraz wyrażenie regularne, do którego nie powinna pasować pierwsza linia w pliku. Możesz użyć tego ostatniego argumentu, aby sprawdzić, czy nagłówek jest już uwzględniony.

Ten skrypt automatycznie pominie pierwszą linię w pliku, jeśli zaczyna się od shebang (#!). Ma to na celu nie zepsucie innych skryptów, które na tym polegają. Jeśli nie chcesz tego zachowania, musisz zakomentować 3 linie w writeheader.

tutaj jest:

#!/usr/bin/python
"""
This script attempts to add a header to each file in the given directory 
The header will be put the line after a Shebang (#!) if present.
If a line starting with a regular expression 'skip' is present as first line or after the shebang it will ignore that file.
If filename is given only files matchign the filename regex will be considered for adding the license to,
by default this is '*'

usage: python addheader.py headerfile directory [filenameregex [dirregex [skip regex]]]

easy example: add header to all files in this directory:
python addheader.py licenseheader.txt . 

harder example adding someone as copyrightholder to all python files in a source directory,exept directories named 'includes' where he isn't added yet:
python addheader.py licenseheader.txt src/ ".*\.py" "^((?!includes).)*$" "#Copyright .* Jens Timmerman*" 
where licenseheader.txt contains '#Copyright 2012 Jens Timmerman'
"""
import os
import re
import sys

def writeheader(filename,header,skip=None):
    """
    write a header to filename, 
    skip files where first line after optional shebang matches the skip regex
    filename should be the name of the file to write to
    header should be a list of strings
    skip should be a regex
    """
    f = open(filename,"r")
    inpt =f.readlines()
    f.close()
    output = []

    #comment out the next 3 lines if you don't wish to preserve shebangs
    if len(inpt) > 0 and inpt[0].startswith("#!"): 
        output.append(inpt[0])
        inpt = inpt[1:]

    if skip and skip.match(inpt[0]): #skip matches, so skip this file
        return

    output.extend(header) #add the header
    for line in inpt:
        output.append(line)
    try:
        f = open(filename,'w')
        f.writelines(output)
        f.close()
        print "added header to %s" %filename
    except IOError,err:
        print "something went wrong trying to add header to %s: %s" % (filename,err)


def addheader(directory,header,skipreg,filenamereg,dirregex):
    """
    recursively adds a header to all files in a dir
    arguments: see module docstring
    """
    listing = os.listdir(directory)
    print "listing: %s " %listing
    #for each file/dir in this dir
    for i in listing:
        #get the full name, this way subsubdirs with the same name don't get ignored
        fullfn = os.path.join(directory,i) 
        if os.path.isdir(fullfn): #if dir, recursively go in
            if (dirregex.match(fullfn)):
                print "going into %s" % fullfn
                addheader(fullfn, header,skipreg,filenamereg,dirregex)
        else:
            if (filenamereg.match(fullfn)): #if file matches file regex, write the header
                writeheader(fullfn, header,skipreg)


def main(arguments=sys.argv):
    """
    main function: parses arguments and calls addheader
    """
    ##argument parsing
    if len(arguments) > 6 or len(arguments) < 3:
        sys.stderr.write("Usage: %s headerfile directory [filenameregex [dirregex [skip regex]]]\n" \
                         "Hint: '.*' is a catch all regex\nHint:'^((?!regexp).)*$' negates a regex\n"%sys.argv[0])
        sys.exit(1)

    skipreg = None
    fileregex = ".*"
    dirregex = ".*"
    if len(arguments) > 5:
        skipreg = re.compile(arguments[5])
    if len(arguments) > 3:
        fileregex =  arguments[3]
    if len(arguments) > 4:
        dirregex =  arguments[4]
    #compile regex    
    fileregex = re.compile(fileregex)
    dirregex = re.compile(dirregex)
    #read in the headerfile just once
    headerfile = open(arguments[1])
    header = headerfile.readlines()
    headerfile.close()
    addheader(arguments[2],header,skipreg,fileregex,dirregex)

#call the main method
main()

W przypadku Javy możesz użyć wtyczki Maven's License: http://code.google.com/p/maven-license-plugin/

Ok, tutaj jest proste narzędzie interfejsu użytkownika tylko dla systemu Windows, które wyszukuje wszystkie pliki określonego typu w folderze, dołącza tekst, który chcesz, na górze (tekst licencji) i kopiuje wynik do innego katalogu (unikając potencjalnych problemów z nadpisaniem) . Jest to również bezpłatne. Wymagany .Net 4.0.

Właściwie jestem autorem, więc nie krępuj się prosić o poprawki lub nowe funkcje ... ale bez obietnic dotyczących harmonogramu dostaw. ;)

więcej informacji: narzędzie License Header na Amazify.com

Sprawdź dodatek do licencji. Obsługuje wiele plików kodu (nawet niestandardowych) i poprawnie obsługuje istniejące nagłówki. Zawiera już szablony dla najpopularniejszych licencji Open Source.

Oto jeden, który zwinąłem w PHP, aby zmodyfikować pliki PHP. Miałem również do usunięcia informacje o starej licencji, więc najpierw zastępuje stary tekst, a następnie dodaje nowy tekst natychmiast po otwarciu

<?php
class Licenses
{
    protected $paths = array();
    protected $oldTxt = '/**
 * Old license to delete
 */';
    protected $newTxt = '/**
 * @license    http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 */';

    function licensesForDir($path)
    {
        foreach(glob($path.'/*') as $eachPath)
        {
            if(is_dir($eachPath))
            {
                $this->licensesForDir($eachPath);
            }
            if(preg_match('#\.php#',$eachPath))
            {
                $this->paths[] = $eachPath;
            }
        }
    }

    function exec()
    {

        $this->licensesForDir('.');
        foreach($this->paths as $path)
        {
            $this->handleFile($path);
        }
    }

    function handleFile($path)
    {
        $source = file_get_contents($path);
        $source = str_replace($this->oldTxt, '', $source);
        $source = preg_replace('#\<\?php#',"<?php\n".$this->newTxt,$source,1);
        file_put_contents($path,$source);
        echo $path."\n";
    }
}

$licenses = new Licenses;
$licenses->exec();

Oto jeden, który znalazłem na liście Apache. Jest napisany w języku Ruby i wydaje się łatwy do odczytania. Powinieneś nawet być w stanie wywołać to z prowizji, aby uzyskać dodatkową wyjątkową uprzejmość. :)

Jeśli nadal go potrzebujesz, napisałem małe narzędzie o nazwie SrcHead . Możesz go znaleźć pod adresem http://www.solvasoft.nl/downloads.html

jeśli używasz sbt, jest https://github.com/Banno/sbt-license-plugin