georchestra/update-licence-headers.sh at master · jdev-org/georchestra · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
#!/bin/bash

# This script checks for the presence of a specific license header in source files,
# adds the header if missing, and updates the copyright year if outdated.
# It supports multiple file types and excludes certain directories and files.
# Usage: Run this script in the root directory of the project.

CURRENT_YEAR=$(date +"%Y")
LICENSE_HEADER='/*
 * Copyright (C) 2009-'"$CURRENT_YEAR"' by the geOrchestra PSC
 *
 * This file is part of geOrchestra.
 *
 * geOrchestra 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 3 of the License, or (at your option)
 * any later version.
 *
 * geOrchestra 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
 * geOrchestra.  If not, see <http://www.gnu.org/licenses/>.
 */'

# Check what should be found in file
header="This file is part of geOrchestra."
extensions=(".java" ".js" ".ts" ".css" ".less" ".html" ".jsp")
exclude_dirs=("node_modules" "lib" "dist" "geonetwork" "geoserver-submodule" "geowebcache" ".mvn" "target" "build" "bin" "out" "vendor" "bootstrap*" ".git" ".idea" ".gradle" "assets" "docs")
exclude_files=("package-lock.json" "yarn.lock" "jquery.js" "select2.full.js" "*.min.js" "*.min.css" "*.svg" "*.md" "*.txt" "*.json" "*.xml")

# Build find command to locate files with specific extensions
find_command="find ."

# Add exclude directories
for dir in "${exclude_dirs[@]}"; do
  find_command+=" -not -path '*/$dir/*' -not -path '*/$dir'"
done

# Add exclude files
for file in "${exclude_files[@]}"; do
  find_command+=" -not -name '$file'"
done

# Add file extensions using -o (OR) operator
find_command+=" -type f \( -false"
for ext in "${extensions[@]}"; do
  find_command+=" -o -name \"*$ext\""
done
find_command+=" \)"

# Execute the find command
all_files=$(eval "$find_command")

# Separate files with missing headers and files with outdated year
missing_header_files=""
outdated_year_files=""

while IFS= read -r file; do
  if grep -q "$header" "$file"; then
    # File has license header, check for outdated year
    if grep -q "Copyright (C) 2009-[0-9]\{4\} by the geOrchestra PSC" "$file"; then
      if ! grep -q "Copyright (C) 2009-$CURRENT_YEAR by the geOrchestra PSC" "$file"; then
        outdated_year_files+="$file"$'\n'
      fi
    fi
  else
    # File is missing license header
    missing_header_files+="$file"$'\n'
  fi
done <<< "$all_files"

# Trim trailing newlines
missing_header_files=$(echo "$missing_header_files" | sed '/^$/d')
outdated_year_files=$(echo "$outdated_year_files" | sed '/^$/d')

# Handle files with missing headers
if [ -z "$missing_header_files" ]; then
  echo "All source files contain the header."
else
  file_count=$(echo "$missing_header_files" | wc -l)
  echo "The following files are missing the header ($file_count files):"
  echo "$missing_header_files"

  echo
  echo "Do you want to add the license to these files? (y/n)"
  read -r response

  if [[ "$response" =~ ^([yY][eE][sS]|[yY])$ ]]; then
    echo "Adding license to files..."

    while IFS= read -r file; do
      # Skip if file doesn't exist or is empty
      [ ! -f "$file" ] && continue

      echo "Processing $file"

      # Determine comment style based on file extension
      ext="${file##*.}"
      case "$ext" in
        java|js|ts|css|less)
          # Create temp file and add license header
          temp_file=$(mktemp)
          echo "$LICENSE_HEADER" > "$temp_file"
          echo "" >> "$temp_file"  # Add a blank line after the license
          cat "$file" >> "$temp_file"
          mv "$temp_file" "$file"
          ;;
        html)
          # For HTML files, we need to check if the file starts with <!DOCTYPE> or <html>
          # If it does, insert the license after it as an HTML comment
          temp_file=$(mktemp)
          if grep -q "<!DOCTYPE" "$file" || grep -q "<html" "$file"; then
            head_line=$(grep -n -m 1 -E '<!DOCTYPE|<html' "$file" | cut -d: -f1)
            head_content=$(head -n "$head_line" "$file")
            tail_content=$(tail -n +$((head_line + 1)) "$file")

            echo "$head_content" > "$temp_file"
            echo "<!--" >> "$temp_file"
            echo "$LICENSE_HEADER" | sed 's|/\*||' | sed 's|\*/||' | sed 's|^ \*||g' >> "$temp_file"
            echo "-->" >> "$temp_file"
            echo "" >> "$temp_file"  # Add a blank line
            echo "$tail_content" >> "$temp_file"
          else
            echo "<!--" > "$temp_file"
            echo "$LICENSE_HEADER" | sed 's|/\*||' | sed 's|\*/||' | sed 's|^ \*||g' >> "$temp_file"
            echo "-->" >> "$temp_file"
            echo "" >> "$temp_file"  # Add a blank line
            cat "$file" >> "$temp_file"
          fi
          mv "$temp_file" "$file"
          ;;
        jsp)
          # For JSP files, use JSP comment syntax <%-- --%>
          temp_file=$(mktemp)
          echo "<%--" > "$temp_file"
            echo "$LICENSE_HEADER" | sed 's|/\*||' | sed 's|\*/||' | sed 's|^ \*||g' >> "$temp_file"
          echo "--%>" >> "$temp_file"
          echo "" >> "$temp_file"  # Add a blank line
          cat "$file" >> "$temp_file"
          mv "$temp_file" "$file"
          ;;
        *)
          echo "Skipping $file: unsupported file extension"
          continue
          ;;
      esac
    done <<< "$missing_header_files"

    echo "License added successfully!"
  else
    echo "Operation cancelled for missing licenses."
  fi
fi

# Handle files with outdated year
if [ -n "$outdated_year_files" ]; then
  file_count=$(echo "$outdated_year_files" | wc -l)
  echo
  echo "The following files have outdated copyright year ($file_count files):"
  echo "$outdated_year_files"

  echo
  echo "Do you want to update the copyright year to $CURRENT_YEAR in these files? (y/n)"
  read -r response

  if [[ "$response" =~ ^([yY][eE][sS]|[yY])$ ]]; then
    echo "Updating copyright year in files..."

    while IFS= read -r file; do
      echo "Updating $file"
      # Use sed to replace the year in the copyright line
      if [[ "$OSTYPE" == "darwin"* ]]; then
        # macOS version of sed requires backup extension
        sed -i '' "s/Copyright (C) 2009-[0-9]\{4\} by the geOrchestra PSC/Copyright (C) 2009-$CURRENT_YEAR by the geOrchestra PSC/g" "$file"
      else
        # Linux version
        sed -i "s/Copyright (C) 2009-[0-9]\{4\} by the geOrchestra PSC/Copyright (C) 2009-$CURRENT_YEAR by the geOrchestra PSC/g" "$file"
      fi
    done <<< "$outdated_year_files"

    echo "Copyright year updated successfully!"
  else
    echo "Operation cancelled for year updates."
  fi
fi

if [ -z "$missing_header_files" ] && [ -z "$outdated_year_files" ]; then
  echo "All files have the correct license header with the current year ($CURRENT_YEAR)."
fi