स्रोत फ़ाइलों में लाइसेंस हेडर जोड़ने के लिए उपकरण? [बन्द है]


89

मैं एक उपकरण की तलाश कर रहा हूँ, जो थोक में, कुछ स्रोत फ़ाइलों में एक लाइसेंस हैडर जोड़ देगा, जिनमें से कुछ में पहले से ही हेडर है। क्या कोई ऐसा टूल है जो हेडर डाल देगा, अगर वह पहले से मौजूद नहीं है?

संपादित करें: मैं जानबूझकर इस सवाल का जवाब नहीं दे रहा हूं, क्योंकि उत्तर मूल रूप से सभी पर्यावरण-विशिष्ट और व्यक्तिपरक हैं


5
"मैं जानबूझकर इस सवाल का जवाब नहीं दे रहा हूं, क्योंकि उत्तर मूल रूप से सभी पर्यावरण-विशिष्ट और व्यक्तिपरक हैं" क्या आप छद्म कोड जैसे पर्यावरणीय समाधान की तलाश कर रहे हैं? यदि नहीं, तो कृपया हमें बताएं कि आप किस वातावरण के साथ काम कर रहे हैं।
ज्रेममेल

1
jrummell: नहीं, पर्यावरण-अज्ञेय समाधान की तलाश में नहीं। उन चीजों की तलाश कर रहा था जो एक बहु-पर्यावरणीय टीम थी, जिसका मैं उपयोग कर सकता था।
एलेक्स लीमैन

क्या विंडोज़ यूआई ऐप आपको ऐसा करने देगा, जो एक स्वीकार्य उत्तर हो सकता है?
ब्रैडी मोरित्ज़

@boomhauer मैं विंडोज़ यूआई ऐप की तलाश में हूं। किसी के बारे में पता है?
1912 पर Jus12

मैंने नीचे एक नया उत्तर जोड़ा, यह बस यही करना चाहिए।
ब्रैडी मोरित्ज़

जवाबों:


61
#!/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

1
में "$ @" के लिए एक बहुत अच्छा विकल्प है। यदि आपके VCS प्रणाली को उन की आवश्यकता है, तो आप चेकआउट के साथ आविष्कारशील भी हो सकते हैं।
जोनाथन लेफ्लर 3

10
-1, आपको उद्धृत करना चाहिए"$i"
एलेक्स-डैनियल जकिमेंको-ए।

मुझे लगता है कि यह उप
श्रेणियों

2
@knocte for i in $(find /folder -name '*.cc');उपनिर्देशिका पर स्क्रिप्ट को चलाने के लिए इसके साथ लूप को बदलें
जॉइस

16

अजगर समाधान, अपनी जरूरत के लिए संशोधित करें

विशेषताएं:

  • UTF हेडर संभालता है (अधिकांश IDE के लिए महत्वपूर्ण)
  • दिए गए मुखौटे से गुजरने वाली लक्ष्य निर्देशिका में सभी फ़ाइलों को पुन: अद्यतन करता है (अपनी भाषा के .em .cava, ..etc के लिए .endwith पैरामीटर को संशोधित करें)।
  • पिछले कॉपीराइट पाठ को अधिलेखित करने की क्षमता (ऐसा करने के लिए पुराना कॉपीराइट पैरामीटर प्रदान करें)
  • वैकल्पिक रूप से बहिष्करण सरणी में दी गई निर्देशिकाओं को छोड़ देता है

-

# 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()

6
संभवत: अपनी स्क्रिप्ट का उल्लेख करने के लिए दुख नहीं होगा।
दना

16

की जाँच करें कॉपीराइट-हैडर RubyGem। यह php, c, h, cpp, hpp, hh, rb, css, js, html में समाप्त होने वाली एक्सटेंशन वाली फाइलों का समर्थन करता है। यह हेडर को भी जोड़ और हटा सकता है।

इसे टाइप करके स्थापित करें " sudo gem install copyright-header"

उसके बाद, कुछ ऐसा कर सकते हैं:

copyright-header --license GPL3 \
  --add-path lib/ \
  --copyright-holder 'Dude1 <dude1@host.com>' \
  --copyright-holder 'Dude2 <dude2@host.com>' \
  --copyright-software 'Super Duper' \
  --copyright-software-description "A program that makes life easier" \
  --copyright-year 2012 \
  --copyright-year 2012 \
  --word-wrap 80 --output-dir ./

यह --license- फ़ाइल तर्क का उपयोग करके कस्टम लाइसेंस फ़ाइलों का भी समर्थन करता है।


यह बहुत अच्छा है सिवाय इसके कि यह मौजूदा मौजूदा हेडर को नहीं हटाता है :(
pgpb.padilla

3
यदि आप उनके लिए कोई टेम्पलेट बनाते हैं, तो आप मौजूदा हेडर निकाल सकते हैं। टेम्पलेट को तर्क के साथ स्क्रिप्ट के तर्क के रूप में पास करें --license-file, और --remove-pathसभी फ़ाइलों से उस सटीक शीर्ष लेख को हटाने के लिए ध्वज का उपयोग करें। मूल रूप से, कई अलग-अलग प्रकार के हेडर हैं, मज़बूती से उन्हें हटाने के लिए एक एल्गोरिथ्म बनाना गैर-तुच्छ है।
एरिक ओस्टर्मन

1
हमने हाल ही में एक Dockerfileबहुत स्थापित किया है ताकि रूबी निर्भरता स्थापित हो सके, अब कोई समस्या नहीं है
एरिक ओस्टरमैन

15

यहाँ एक Bash स्क्रिप्ट दी गई है, जिससे आप यह मान लेंगे कि फ़ाइल में लाइसेंस हेडर है।

फ़ाइल 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  

अब इसे अपनी स्रोत निर्देशिका में चलाएं:

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

1
यदि फ़ाइल नाम में अंक हैं, तो sed अभिव्यक्ति अच्छी तरह से काम नहीं करेगी। इसके बजाय, उपयोग करने पर विचार करेंcut -f1 -d ' '
schweerelos

1
@ रोसेनफील्ड समापन एकल उद्धरण निर्यात विवरण में याद किया जाता है।
तलस्पिन_कीट

आपको कमांड में कोष्ठक की आवश्यकता क्यों है? यह मेरे लिए विफल रहा
knocte

13

संपादित करें: यदि आप ग्रहण का उपयोग कर रहे हैं, तो वहाँ है एक प्लगइन है

मैंने सिल्वर ड्रैगन के उत्तर पर आधारित एक साधारण अजगर स्क्रिप्ट लिखी। मुझे और अधिक लचीले समाधान की आवश्यकता थी इसलिए मैं इसके साथ आया। यह आपको एक निर्देशिका में सभी फ़ाइलों के लिए एक शीर्ष लेख जोड़ने की अनुमति देता है, पुनरावर्ती। आप वैकल्पिक रूप से एक regex जोड़ सकते हैं जो फ़ाइल नाम से मेल खाना चाहिए, और एक regex जो निर्देशिका नामों से मेल खाना चाहिए और एक regex जो फ़ाइल में पहली पंक्ति से मेल नहीं खाना चाहिए। आप इस अंतिम तर्क का उपयोग यह जांचने के लिए कर सकते हैं कि क्या हेडर पहले ही शामिल है।

यह स्क्रिप्ट स्वचालित रूप से किसी फ़ाइल में पहली पंक्ति को छोड़ देगी यदि यह एक शेबंग (#!) से शुरू होती है। इस पर निर्भर अन्य स्क्रिप्ट को तोड़ने के लिए नहीं। यदि आप इस व्यवहार की इच्छा नहीं रखते हैं, तो आपको 3 पंक्तियाँ लिखनी होंगी।

यह रहा:

#!/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()

3
प्लगइन के लिए टूटी लिंक
mjaggard

मुझे लगता है कि यह हो सकता है: wiki.eclipse.org/Development_Resources/…
mbdevpl

मैं इस के अपने अजगर पैकेज संस्करण लिखने से पहले अच्छी तरह से Google में विफल रहा। मैं भविष्य के सुधार के लिए आपके समाधान की ओर ध्यान आकर्षित करूंगा। github.com/zkurtz/license_proliferator
zkurtz


11

ठीक है यहां एक साधारण विंडोज़-केवल यूआई उपकरण है जो आपके निर्दिष्ट प्रकार की सभी फ़ाइलों को एक फ़ोल्डर में खोजता है, आपके द्वारा शीर्ष (आपकी लाइसेंस पाठ) की इच्छा वाले पाठ को प्रस्तुत करता है, और परिणाम को दूसरी निर्देशिका में कॉपी करता है (संभावित ओवरराइट समस्याओं से बचने) । यह भी मुफ्त है। आवश्यक .Net 4.0।

मैं वास्तव में लेखक हूं, इसलिए फ़िक्सेस या नई सुविधाओं का अनुरोध करने के लिए स्वतंत्र महसूस करता हूं ... हालांकि डिलीवरी शेड्यूल पर कोई वादा नहीं किया गया है। ;)

अधिक जानकारी: Amazify.com पर लाइसेंस हैडर टूल


इसके अलावा, मैं इस पर किसी भी प्रतिक्रिया की सराहना करता हूँ, धन्यवाद
ब्रैडी मोरिट्ज़

1
मैं वास्तव में सॉफ्टवेयर को पसंद करता हूं, लेकिन शीर्षलेख में फ़ाइल नाम दर्ज करने के लिए मैक्रो की आवश्यकता होती है। Allso अच्छा होगा फ़ाइलों की सूची दिखाने के लिए एक विकल्प के साथ संपादित करने के लिए फ़ाइलों को बाहर। (:
hs2d

धन्यवाद, मैक्रो और अपवर्जन सूची एक महान विचार है
ब्रैडी मोरिट्ज़

आपका लिंक समाप्त हो गया है। इसे साइट से डाउनलोड करना संभव नहीं है
वैलीजोन

धन्यवाद, मैं इसकी मरम्मत करवाऊंगा
ब्रैडी मोरिट्ज़

5

लाइसेंस-योजक की जाँच करें। यह कई कोड फ़ाइलों (यहां तक ​​कि कस्टम वाले) का समर्थन करता है और मौजूदा हेडर को सही ढंग से संभालता है। सबसे आम ओपन सोर्स लाइसेंस के लिए पहले से ही टेम्प्लेट के साथ आता है।



GitHub अब पाता है: github.com/sanandrea/License-Adder
koppor

4

यहाँ एक है जिसे मैंने PHP में संशोधित किया है PHP फ़ाइलों को संशोधित करने के लिए। मेरे पास हटाने के लिए पुरानी लाइसेंस जानकारी भी थी, इसलिए यह पुराने पाठ को पहले बदल देता है, फिर उद्घाटन के तुरंत बाद नया पाठ जोड़ता है

<?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();

3

यहाँ एक मुझे अपाचे सूची में मिला है। रूबी में लिखा गया है और पढ़ने में काफी आसान लगता है। तुम भी अतिरिक्त विशेष सुंदरता के लिए इसे रेक से कॉल करने में सक्षम होना चाहिए। :)


1

अगर आपको अभी भी एक की आवश्यकता है, तो एक छोटा उपकरण है जिसे मैंने लिखा है, जिसका नाम SrcHead है । आप इसे http://www.solvasoft.nl/downloads.html पर पा सकते हैं


3
डाउनलोड पृष्ठ से: "यह विंडोज के लिए लिखा गया है और काम करने के लिए .NET फ्रेमवर्क 2.0 की आवश्यकता है।"
रिकार्डो मुरी

C / C ++ स्टाइल हेडर और एक यूनिकोड BOM जोड़ता है। अर्थ: की सामग्री प्रत्येक पंक्ति में पहले से header.txtलिखी गई है //और पहली पंक्ति यूनिकोड BOM से शुरू होती है।
कोपरपॉ

हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.