Script to update Trac copyright date in license header of source files

[anonymous]

Copyright © 2003-2008 Edgewall Software All rights reserved.

​http://trac.edgewall.org/wiki/TracLicense

update this :)

[Remy Blank]

Done, thanks. We should probably also update all source files.

[Thijs Triemstra <lists@…>]

PatchWelcome?

[Remy Blank]

Only if the patch contains a script that automates the process on the source files :)

[Thijs Triemstra <lists@…>]

Adding more details to summary.

[Thijs Triemstra]

update user-visible copyright for 2011

[Thijs Triemstra]

Can the attached patch be applied to 0.12.2 before it's released?

[Thijs Triemstra]

And TracLicense needs an update (I can't edit it).

[Remy Blank]

Replying to thijstriemstra:

Can the attached patch be applied to 0.12.2 before it's released?

TracLicense was updated. The user-visible copyright years have been updated in [10502]. As for the copyrights at the top of the files, I would still prefer having a script that automates the process, to be placed in contrib.

[Thijs Triemstra]

Moving it back to it's old milestone.

[Ryan J Ollos]

Here is a sed one-liner for updating py files copyright to YEAR:

$ YEAR=2018 find . -name "*.py" -type f -exec sed -i '' 's/^\(# Copyright .*20[01][0-9]-\)\(20[01][0-9]\)\( Edgewall\)/\1'$YEAR'\3/g' {} \;

[Ryan J Ollos]

Updated headers on 1.0-stable in r16770, merged in r16771 and r16773. We can adjust the headers or regex if there are any missed updates. Still to do, edits for other file types (html, js, …).

[Ryan J Ollos]

Proposed changes:

Makefile

@@ -586 +586 @@
   release-clean       remove the packages
 
   update-help         fetches latest help/guide from Edgewall
+  update-copyright    update copyright year in file headers
   checksum            MD5 and SHA1 checksums of packages of given version
   upload              scp the packages of given version to user@lynx:~/dist
 
@@ -595 +596 @@
 export HELP_release
 
 .PHONY: release release-src wheel dist release-exe wininst
-.PHONY: release-clean checksum update-help upload
+.PHONY: release-clean checksum update-copyright update-help upload
 
 ifeq "$(OS)" "Windows_NT"
 release: release-exe
@@ -664 +665 @@
        )
 endif
 
+copyright_re := "s/^($$PREFIX)(Copyright \(C\) 20[01][0-9])(-20[01][0-9])?$\
+    ( Edgewall Software)/\1\2-$(year)\4/g"
+
+update-copyright:
+ifeq "$(year)" ""
+       $(error "specify year= on the make command-line")
+else
+       @PREFIX="<!--!  "; find . -type f -name "*.html" \
+           -exec sed -i '' -E $(copyright_re) {} \;
+       @PREFIX="\# "; find . -type f \
+           \( -name "*.py" -o -name "*.ps1" -o -name "*.cgi" -o -name "*.fcgi" \) \
+           -exec sed -i '' -E $(copyright_re) {} \;
+       @PREFIX="\# "; sed -i '' -E $(copyright_re) \
+           contrib/trac-svn-hook contrib/trac-pre-commit-hook
+       @PREFIX=":: "; sed -i '' -E $(copyright_re) \
+           contrib/trac-svn-post-commit-hook.cmd
+       @PREFIX=; sed -i '' -E $(copyright_re) COPYING
+endif
+
 update-help:
        @python contrib/checkwiki.py -d --prefix=$(prefix)
        @python contrib/wiki2rst.py TracUpgrade > UPGRADE

Let me know if you notice any other files that need an update of the year in the file header.

DONE Update TracDev/ReleaseChecklist#Otherrepositoryfiles.

[Ryan J Ollos]

Makefile changes committed in [16809:16811].

File header changes in [16812:16814].

[Ryan J Ollos]

For reference, I used the trick in ​SO:50863019/121694 to split the copyright_re regex across multiple lines. There are some warnings about using the undocumented/undefined behavior, but if this fails in the future it will be easy to modify.

[anonymous]

How about a python contrib/update-copyright.py based on ​SO?

[Jun Omae]

Replying to anonymous:

How about a python contrib/update-copyright.py based on ​SO?

+1. The -i option of sed is not portable between BSD sed and GNU sed.

$ sed --version | head -1
sed (GNU sed) 4.2.2
$ make update-copyright year=2019
sed: can't read s/^(<!--!  )(Copyright \(C\) 20[01][0-9])(-20[01][0-9])?( Edgewall Software)$/\1\2-2019\4/g: No such file or directory
...
sed: can't read s/^(\# )(Copyright \(C\) 20[01][0-9])(-20[01][0-9])?( Edgewall Software)$/\1\2-2019\4/g: No such file or directory
Makefile:675: recipe for target 'update-copyright' failed
make: *** [update-copyright] Error 2

Other suggestions:

1. Copyright years in *.po files should be replaced.
2. In addition, I think it is good that copyright years in about.html​ and console.py​ would be replaced by update-copyright task.

[Ryan J Ollos]

The suggestions and porting to Python sound good to me, but I'm probably not going to spend any more time on this in the near future since the sed in the makefile gets the job done for me on OSX and there are numerous other things to work on.

[Jun Omae]

I tried compatibility fix without porting to Python script, [aa4a860a8/jomae.git] (jomae.git@t9567.1). Tested with OSX 10.14.3 and Ubuntu 16.04.5.

[Ryan J Ollos]

Those changes work well for me on OSX 10.14.3. Thanks for fixing the issue.

Edited TracDev/ReleaseChecklist@137.

[Jun Omae]

Thanks. Committed in [16889-16891].

[Ryan J Ollos]

make update-copyright needs to adapt to Jinja2 templates. I'll push the change later.

Makefile

@@ -776 +776 @@
              && echo 1), \
            sed --in-place= -r -e, \
            sed -i '' -E))
-       @PREFIX="<!--!  "; find . -type f -name "*.html" \
+       @PREFIX="<!--!\s+"; find . -type f -name "*.html" \
+           -exec $(SED) $(copyright_re) {} \;
+       @PREFIX="\{\#\s+"; find . -type f -name "*.html" \
            -exec $(SED) $(copyright_re) {} \;
        @PREFIX="\# "; find . -type f \
            \( -name "*.py" -o -name "*.po" -o -name "*.pot" -o \

[Ryan J Ollos]

comment:27 change committed to 1.4-stable in r17292, merged to trunk in r17293.

[Ryan J Ollos]

Copyright line of trunk/contrib/trac-svn-post-commit-hook.cmd@17023​ isn't getting updated when running make update-copyright on OSX. The svn:eol-style is CRLF (11490​). Options:

1. Change svn:eol-style to native.
2. Modify the regex:

   Makefile

   @@ -765 +765 @@
    endif
    
    copyright_re := "s/^($$PREFIX)(Copyright \(C\) 20[0-9][0-9])(-20[0-9][0-9])?$\
   -    ( Edgewall Software)$$/\1\2-$(year)\4/g"
   +    ( Edgewall Software[\r]?)$$/\1\2-$(year)\4/g"
    
    update-copyright:
    ifeq "$(year)" ""

After the change is committed I'll update the copyright on 1.0-stable and 1.2-stable.

[Ryan J Ollos]

Updated copyright on 1.0-stable in r17305, on 1.2-stable in r17307.

Fixed lines containing CRLF not matched in r17306, merged in [17308:17310].

[Ryan J Ollos]

Replying to Ryan J Ollos:

comment:27 change committed to 1.4-stable in r17292, merged to trunk in r17293.

In [17293#file36] I accidentally reverted a change r17290. This was fixed in r17328.