From 9f638e4fd4b8ccad7a350648b6b637ed55bc1597 Mon Sep 17 00:00:00 2001 From: frnmst/Franco Masotti Date: Fri, 13 Jan 2017 20:09:39 +0100 Subject: [PATCH] Added files. --- LICENSE | 121 +++++++++++++++++++++++++++++ README.md | 58 +++++++++++++- configrc | 36 +++++++++ monthly_attendace_paper.sh | 155 +++++++++++++++++++++++++++++++++++++ 4 files changed, 369 insertions(+), 1 deletion(-) create mode 100644 LICENSE create mode 100644 configrc create mode 100755 monthly_attendace_paper.sh diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0e259d4 --- /dev/null +++ b/LICENSE @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/README.md b/README.md index ab90531..0126115 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,58 @@ # monthly-attendance-paper -A simple bash script that generates a monthly printout template to be used between an employer and employee + +A simple bash script that generates a monthly printout calendar template to be +used between an employer and employee. + +## Dependencies + +All of them should be already installed in your system: + +- [GNU Bash](http://www.gnu.org/software/bash/bash.html) +- [Coreutils](https://www.gnu.org/software/coreutils/) +- [Gawk](http://www.gnu.org/software/gawk/) +- [util-linux](https://www.kernel.org/pub/linux/utils/util-linux/) + +Optionally, to print the template: + +- [CUPS](http://www.cups.org/) + +or whatever printing system is able to print from the +standard input + +## Configuration + +Edit `configrc` based on your needs. +variable names are self-explanatory. + +Important variables are: + + this_month + this_year + employer + employee + +as well as the days of the week, which you can translate in +your language. + +You can also edit the date formats in the following functions: + + get_full_string() + print_day() + +## Running + + $ ./monthly_attendace_paper.sh + +## Printing + + $ ./monthly_attendace_paper.sh | lpr + +## Warning + +This script does not check any input nor output for errors. +That's up to you. + +## License + +CC0. + diff --git a/configrc b/configrc new file mode 100644 index 0000000..8eb78ed --- /dev/null +++ b/configrc @@ -0,0 +1,36 @@ +# monthly-attendace-paper - A simple bash script that generates a monthly +# printout template to be used between an employer and employee. +# +# Written in 2017 by Franco Masotti/frnmst +# +# To the extent possible under law, the author(s) have dedicated all +# copyright and related and neighboring rights to this software to the public +# domain worldwide. This software is distributed without any warranty. +# +# You should have received a copy of the CC0 Public Domain Dedication along +# with this software. If not, see +# . + +this_month="02" +this_year="2017" + +title="Monthly attendance paper printout" +employer="Employer: THE EMPLOYER" +employee="Employee: THE EMPLOYEE" +date_id="Month and Year: $this_month $this_year" + +day_column_header="Date/Month Day" +args_column_header="Worked Hours / Entry time - Exit time" +format="Format: \"$day_column_header $args_column_header\"" + +highlited_day="Sun" + +Mon="Monday" +Tue="Tuesday" +Wed="Wednesday" +Thu="Thursday" +Fri="Friday" +Sat="Saturday" +Sun="Sunday" + + diff --git a/monthly_attendace_paper.sh b/monthly_attendace_paper.sh new file mode 100755 index 0000000..4f55b0f --- /dev/null +++ b/monthly_attendace_paper.sh @@ -0,0 +1,155 @@ +#!/usr/bin/env bash + +# monthly-attendace-paper - A simple bash script that generates a monthly +# printout template to be used between an employer and employee. +# +# Written in 2017 by Franco Masotti/frnmst +# +# To the extent possible under law, the author(s) have dedicated all +# copyright and related and neighboring rights to this software to the public +# domain worldwide. This software is distributed without any warranty. +# +# You should have received a copy of the CC0 Public Domain Dedication along +# with this software. If not, see +# . + +. ./configrc + +declare -A days_string +days_string[Mon]="$Mon" +days_string[Tue]="$Tue" +days_string[Wed]="$Wed" +days_string[Thu]="$Thu" +days_string[Fri]="$Fri" +days_string[Sat]="$Sat" +days_string[Sun]="$Sun" + +declare -A days_id +days_id[0]=Mon +days_id[1]=Tue +days_id[2]=Wed +days_id[3]=Thu +days_id[4]=Fri +days_id[5]=Sat +days_id[6]=Sun + +### + +printf "%s\n\n\n" "$title" +printf "%s\n\n" "$employer" +printf "%s\n\n" "$employee" +printf "%s\n" "$date_id" +printf "\n\n" + +### + +is_febuary="false" +if [ "$this_month" = "02" ]; then + is_febuary="true" +fi + +# Algorithm got from Wikipedia. +is_leap_year="false" +if [ $(($this_year % 4)) -ne 0 ]; then + is_leap_year="false" +elif [ $(($this_year % 100)) -ne 0]; then + is_leap_year="true" +elif [ $(($this_year % 400)) -ne 0]; then + is_leap_year="false" +else + is_leap_year="true" +fi + +get_cal="$(cal -m $this_month $this_year | awk 'NF > 0' | tail -n +3)" + +# Starting from monday (1) get the first and last day id of the month. +first_cal_line="$(printf "%s" "$get_cal" | head -n1)" +last_cal_line="$(printf "%s" "$get_cal" | tail -n1)" + +first_day_id=$(printf "$first_cal_line" | wc -w) +first_day_id=$((7-$first_day_id+1)) +first_day_id=$(($first_day_id-1)) + +last_day_id=$(printf "%s" "$last_cal_line" | wc -w) +last_day_number=$(echo $last_cal_line | awk "{print \$$last_day_id}") +last_day_id=$(($last_day_id-1)) + +day_offset=15 +if [ "$is_febuary" = "true" ]; then + day_offset=14 +fi +month="$(seq 1 $day_offset)" + +tabulation() +{ + printf "\t\t\t" +} + +newline() +{ + printf "\n\n\n" +} + +get_full_string() +{ + local day=$1 + local ds="$2" + + printf "$day/$this_month\t$ds" +} + +print_day() +{ + local day=$1 + local day_id=$2 + local dd="${days_id[$day_id]}" + local ds="${days_string[$dd]}" + + # If sunday + if [ $dd = $highlited_day ]; then + printf "||" + get_full_string "$day" "$ds" + printf "||" + else + printf " " + get_full_string "$day" "$ds" + printf " " + fi +} + +print_day_left() +{ + print_day $1 $2 + tabulation +} + +print_day_right() +{ + print_day $1 $2 + newline +} + +day_id=$first_day_id + +for day in $month; do + print_day_left $day $(($day_id % 7)) + print_day_right $(($day + $day_offset)) $((($day_id + $day_offset) % 7)) + + day_id=$(($day_id + 1)) +done + +# Months with 31 days. +if [ $last_day_number -eq 31 ]; then + tabulation + printf "\t\t" + print_day_right 31 $((($day_id + $day_offset) % 7)) +fi + +if [ "$is_leap_year" = "true" ]; then + tabulation + printf "\t\t" + print_day_right 29 $((($day_id + $day_offset) % 7)) +fi + + +printf "%s\n" "$format"