commit 0da1b046f00c9af49551a68aab9852cb065ec3e0 Author: Mike Burns Date: Sat Oct 16 15:49:01 2021 +0200 initial commit v1.3 diff --git a/HEAD b/HEAD new file mode 100644 index 0000000..cb089cd --- /dev/null +++ b/HEAD @@ -0,0 +1 @@ +ref: refs/heads/master diff --git a/config b/config new file mode 100644 index 0000000..64280b8 --- /dev/null +++ b/config @@ -0,0 +1,6 @@ +[core] + repositoryformatversion = 0 + filemode = false + bare = true + symlinks = false + ignorecase = true diff --git a/description b/description new file mode 100644 index 0000000..498b267 --- /dev/null +++ b/description @@ -0,0 +1 @@ +Unnamed repository; edit this file 'description' to name the repository. diff --git a/hooks/applypatch-msg.sample b/hooks/applypatch-msg.sample new file mode 100644 index 0000000..a5d7b84 --- /dev/null +++ b/hooks/applypatch-msg.sample @@ -0,0 +1,15 @@ +#!/bin/sh +# +# An example hook script to check the commit log message taken by +# applypatch from an e-mail message. +# +# The hook should exit with non-zero status after issuing an +# appropriate message if it wants to stop the commit. The hook is +# allowed to edit the commit message file. +# +# To enable this hook, rename this file to "applypatch-msg". + +. git-sh-setup +commitmsg="$(git rev-parse --git-path hooks/commit-msg)" +test -x "$commitmsg" && exec "$commitmsg" ${1+"$@"} +: diff --git a/hooks/commit-msg.sample b/hooks/commit-msg.sample new file mode 100644 index 0000000..b58d118 --- /dev/null +++ b/hooks/commit-msg.sample @@ -0,0 +1,24 @@ +#!/bin/sh +# +# An example hook script to check the commit log message. +# Called by "git commit" with one argument, the name of the file +# that has the commit message. The hook should exit with non-zero +# status after issuing an appropriate message if it wants to stop the +# commit. The hook is allowed to edit the commit message file. +# +# To enable this hook, rename this file to "commit-msg". + +# Uncomment the below to add a Signed-off-by line to the message. +# Doing this in a hook is a bad idea in general, but the prepare-commit-msg +# hook is more suited to it. +# +# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p') +# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1" + +# This example catches duplicate Signed-off-by lines. + +test "" = "$(grep '^Signed-off-by: ' "$1" | + sort | uniq -c | sed -e '/^[ ]*1[ ]/d')" || { + echo >&2 Duplicate Signed-off-by lines. + exit 1 +} diff --git a/hooks/fsmonitor-watchman.sample b/hooks/fsmonitor-watchman.sample new file mode 100644 index 0000000..14ed0aa --- /dev/null +++ b/hooks/fsmonitor-watchman.sample @@ -0,0 +1,173 @@ +#!/usr/bin/perl + +use strict; +use warnings; +use IPC::Open2; + +# An example hook script to integrate Watchman +# (https://facebook.github.io/watchman/) with git to speed up detecting +# new and modified files. +# +# The hook is passed a version (currently 2) and last update token +# formatted as a string and outputs to stdout a new update token and +# all files that have been modified since the update token. Paths must +# be relative to the root of the working tree and separated by a single NUL. +# +# To enable this hook, rename this file to "query-watchman" and set +# 'git config core.fsmonitor .git/hooks/query-watchman' +# +my ($version, $last_update_token) = @ARGV; + +# Uncomment for debugging +# print STDERR "$0 $version $last_update_token\n"; + +# Check the hook interface version +if ($version ne 2) { + die "Unsupported query-fsmonitor hook version '$version'.\n" . + "Falling back to scanning...\n"; +} + +my $git_work_tree = get_working_dir(); + +my $retry = 1; + +my $json_pkg; +eval { + require JSON::XS; + $json_pkg = "JSON::XS"; + 1; +} or do { + require JSON::PP; + $json_pkg = "JSON::PP"; +}; + +launch_watchman(); + +sub launch_watchman { + my $o = watchman_query(); + if (is_work_tree_watched($o)) { + output_result($o->{clock}, @{$o->{files}}); + } +} + +sub output_result { + my ($clockid, @files) = @_; + + # Uncomment for debugging watchman output + # open (my $fh, ">", ".git/watchman-output.out"); + # binmode $fh, ":utf8"; + # print $fh "$clockid\n@files\n"; + # close $fh; + + binmode STDOUT, ":utf8"; + print $clockid; + print "\0"; + local $, = "\0"; + print @files; +} + +sub watchman_clock { + my $response = qx/watchman clock "$git_work_tree"/; + die "Failed to get clock id on '$git_work_tree'.\n" . + "Falling back to scanning...\n" if $? != 0; + + return $json_pkg->new->utf8->decode($response); +} + +sub watchman_query { + my $pid = open2(\*CHLD_OUT, \*CHLD_IN, 'watchman -j --no-pretty') + or die "open2() failed: $!\n" . + "Falling back to scanning...\n"; + + # In the query expression below we're asking for names of files that + # changed since $last_update_token but not from the .git folder. + # + # To accomplish this, we're using the "since" generator to use the + # recency index to select candidate nodes and "fields" to limit the + # output to file names only. Then we're using the "expression" term to + # further constrain the results. + if (substr($last_update_token, 0, 1) eq "c") { + $last_update_token = "\"$last_update_token\""; + } + my $query = <<" END"; + ["query", "$git_work_tree", { + "since": $last_update_token, + "fields": ["name"], + "expression": ["not", ["dirname", ".git"]] + }] + END + + # Uncomment for debugging the watchman query + # open (my $fh, ">", ".git/watchman-query.json"); + # print $fh $query; + # close $fh; + + print CHLD_IN $query; + close CHLD_IN; + my $response = do {local $/; }; + + # Uncomment for debugging the watch response + # open ($fh, ">", ".git/watchman-response.json"); + # print $fh $response; + # close $fh; + + die "Watchman: command returned no output.\n" . + "Falling back to scanning...\n" if $response eq ""; + die "Watchman: command returned invalid output: $response\n" . + "Falling back to scanning...\n" unless $response =~ /^\{/; + + return $json_pkg->new->utf8->decode($response); +} + +sub is_work_tree_watched { + my ($output) = @_; + my $error = $output->{error}; + if ($retry > 0 and $error and $error =~ m/unable to resolve root .* directory (.*) is not watched/) { + $retry--; + my $response = qx/watchman watch "$git_work_tree"/; + die "Failed to make watchman watch '$git_work_tree'.\n" . + "Falling back to scanning...\n" if $? != 0; + $output = $json_pkg->new->utf8->decode($response); + $error = $output->{error}; + die "Watchman: $error.\n" . + "Falling back to scanning...\n" if $error; + + # Uncomment for debugging watchman output + # open (my $fh, ">", ".git/watchman-output.out"); + # close $fh; + + # Watchman will always return all files on the first query so + # return the fast "everything is dirty" flag to git and do the + # Watchman query just to get it over with now so we won't pay + # the cost in git to look up each individual file. + my $o = watchman_clock(); + $error = $output->{error}; + + die "Watchman: $error.\n" . + "Falling back to scanning...\n" if $error; + + output_result($o->{clock}, ("/")); + $last_update_token = $o->{clock}; + + eval { launch_watchman() }; + return 0; + } + + die "Watchman: $error.\n" . + "Falling back to scanning...\n" if $error; + + return 1; +} + +sub get_working_dir { + my $working_dir; + if ($^O =~ 'msys' || $^O =~ 'cygwin') { + $working_dir = Win32::GetCwd(); + $working_dir =~ tr/\\/\//; + } else { + require Cwd; + $working_dir = Cwd::cwd(); + } + + return $working_dir; +} diff --git a/hooks/post-update.sample b/hooks/post-update.sample new file mode 100644 index 0000000..ec17ec1 --- /dev/null +++ b/hooks/post-update.sample @@ -0,0 +1,8 @@ +#!/bin/sh +# +# An example hook script to prepare a packed repository for use over +# dumb transports. +# +# To enable this hook, rename this file to "post-update". + +exec git update-server-info diff --git a/hooks/pre-applypatch.sample b/hooks/pre-applypatch.sample new file mode 100644 index 0000000..4142082 --- /dev/null +++ b/hooks/pre-applypatch.sample @@ -0,0 +1,14 @@ +#!/bin/sh +# +# An example hook script to verify what is about to be committed +# by applypatch from an e-mail message. +# +# The hook should exit with non-zero status after issuing an +# appropriate message if it wants to stop the commit. +# +# To enable this hook, rename this file to "pre-applypatch". + +. git-sh-setup +precommit="$(git rev-parse --git-path hooks/pre-commit)" +test -x "$precommit" && exec "$precommit" ${1+"$@"} +: diff --git a/hooks/pre-commit.sample b/hooks/pre-commit.sample new file mode 100644 index 0000000..e144712 --- /dev/null +++ b/hooks/pre-commit.sample @@ -0,0 +1,49 @@ +#!/bin/sh +# +# An example hook script to verify what is about to be committed. +# Called by "git commit" with no arguments. The hook should +# exit with non-zero status after issuing an appropriate message if +# it wants to stop the commit. +# +# To enable this hook, rename this file to "pre-commit". + +if git rev-parse --verify HEAD >/dev/null 2>&1 +then + against=HEAD +else + # Initial commit: diff against an empty tree object + against=$(git hash-object -t tree /dev/null) +fi + +# If you want to allow non-ASCII filenames set this variable to true. +allownonascii=$(git config --type=bool hooks.allownonascii) + +# Redirect output to stderr. +exec 1>&2 + +# Cross platform projects tend to avoid non-ASCII filenames; prevent +# them from being added to the repository. We exploit the fact that the +# printable range starts at the space character and ends with tilde. +if [ "$allownonascii" != "true" ] && + # Note that the use of brackets around a tr range is ok here, (it's + # even required, for portability to Solaris 10's /usr/bin/tr), since + # the square bracket bytes happen to fall in the designated range. + test $(git diff --cached --name-only --diff-filter=A -z $against | + LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0 +then + cat <<\EOF +Error: Attempt to add a non-ASCII file name. + +This can cause problems if you want to work with people on other platforms. + +To be portable it is advisable to rename the file. + +If you know what you are doing you can disable this check using: + + git config hooks.allownonascii true +EOF + exit 1 +fi + +# If there are whitespace errors, print the offending file names and fail. +exec git diff-index --check --cached $against -- diff --git a/hooks/pre-merge-commit.sample b/hooks/pre-merge-commit.sample new file mode 100644 index 0000000..399eab1 --- /dev/null +++ b/hooks/pre-merge-commit.sample @@ -0,0 +1,13 @@ +#!/bin/sh +# +# An example hook script to verify what is about to be committed. +# Called by "git merge" with no arguments. The hook should +# exit with non-zero status after issuing an appropriate message to +# stderr if it wants to stop the merge commit. +# +# To enable this hook, rename this file to "pre-merge-commit". + +. git-sh-setup +test -x "$GIT_DIR/hooks/pre-commit" && + exec "$GIT_DIR/hooks/pre-commit" +: diff --git a/hooks/pre-push.sample b/hooks/pre-push.sample new file mode 100644 index 0000000..4ce688d --- /dev/null +++ b/hooks/pre-push.sample @@ -0,0 +1,53 @@ +#!/bin/sh + +# An example hook script to verify what is about to be pushed. Called by "git +# push" after it has checked the remote status, but before anything has been +# pushed. If this script exits with a non-zero status nothing will be pushed. +# +# This hook is called with the following parameters: +# +# $1 -- Name of the remote to which the push is being done +# $2 -- URL to which the push is being done +# +# If pushing without using a named remote those arguments will be equal. +# +# Information about the commits which are being pushed is supplied as lines to +# the standard input in the form: +# +# +# +# This sample shows how to prevent push of commits where the log message starts +# with "WIP" (work in progress). + +remote="$1" +url="$2" + +zero=$(git hash-object --stdin &2 "Found WIP commit in $local_ref, not pushing" + exit 1 + fi + fi +done + +exit 0 diff --git a/hooks/pre-rebase.sample b/hooks/pre-rebase.sample new file mode 100644 index 0000000..6cbef5c --- /dev/null +++ b/hooks/pre-rebase.sample @@ -0,0 +1,169 @@ +#!/bin/sh +# +# Copyright (c) 2006, 2008 Junio C Hamano +# +# The "pre-rebase" hook is run just before "git rebase" starts doing +# its job, and can prevent the command from running by exiting with +# non-zero status. +# +# The hook is called with the following parameters: +# +# $1 -- the upstream the series was forked from. +# $2 -- the branch being rebased (or empty when rebasing the current branch). +# +# This sample shows how to prevent topic branches that are already +# merged to 'next' branch from getting rebased, because allowing it +# would result in rebasing already published history. + +publish=next +basebranch="$1" +if test "$#" = 2 +then + topic="refs/heads/$2" +else + topic=`git symbolic-ref HEAD` || + exit 0 ;# we do not interrupt rebasing detached HEAD +fi + +case "$topic" in +refs/heads/??/*) + ;; +*) + exit 0 ;# we do not interrupt others. + ;; +esac + +# Now we are dealing with a topic branch being rebased +# on top of master. Is it OK to rebase it? + +# Does the topic really exist? +git show-ref -q "$topic" || { + echo >&2 "No such branch $topic" + exit 1 +} + +# Is topic fully merged to master? +not_in_master=`git rev-list --pretty=oneline ^master "$topic"` +if test -z "$not_in_master" +then + echo >&2 "$topic is fully merged to master; better remove it." + exit 1 ;# we could allow it, but there is no point. +fi + +# Is topic ever merged to next? If so you should not be rebasing it. +only_next_1=`git rev-list ^master "^$topic" ${publish} | sort` +only_next_2=`git rev-list ^master ${publish} | sort` +if test "$only_next_1" = "$only_next_2" +then + not_in_topic=`git rev-list "^$topic" master` + if test -z "$not_in_topic" + then + echo >&2 "$topic is already up to date with master" + exit 1 ;# we could allow it, but there is no point. + else + exit 0 + fi +else + not_in_next=`git rev-list --pretty=oneline ^${publish} "$topic"` + /usr/bin/perl -e ' + my $topic = $ARGV[0]; + my $msg = "* $topic has commits already merged to public branch:\n"; + my (%not_in_next) = map { + /^([0-9a-f]+) /; + ($1 => 1); + } split(/\n/, $ARGV[1]); + for my $elem (map { + /^([0-9a-f]+) (.*)$/; + [$1 => $2]; + } split(/\n/, $ARGV[2])) { + if (!exists $not_in_next{$elem->[0]}) { + if ($msg) { + print STDERR $msg; + undef $msg; + } + print STDERR " $elem->[1]\n"; + } + } + ' "$topic" "$not_in_next" "$not_in_master" + exit 1 +fi + +<<\DOC_END + +This sample hook safeguards topic branches that have been +published from being rewound. + +The workflow assumed here is: + + * Once a topic branch forks from "master", "master" is never + merged into it again (either directly or indirectly). + + * Once a topic branch is fully cooked and merged into "master", + it is deleted. If you need to build on top of it to correct + earlier mistakes, a new topic branch is created by forking at + the tip of the "master". This is not strictly necessary, but + it makes it easier to keep your history simple. + + * Whenever you need to test or publish your changes to topic + branches, merge them into "next" branch. + +The script, being an example, hardcodes the publish branch name +to be "next", but it is trivial to make it configurable via +$GIT_DIR/config mechanism. + +With this workflow, you would want to know: + +(1) ... if a topic branch has ever been merged to "next". Young + topic branches can have stupid mistakes you would rather + clean up before publishing, and things that have not been + merged into other branches can be easily rebased without + affecting other people. But once it is published, you would + not want to rewind it. + +(2) ... if a topic branch has been fully merged to "master". + Then you can delete it. More importantly, you should not + build on top of it -- other people may already want to + change things related to the topic as patches against your + "master", so if you need further changes, it is better to + fork the topic (perhaps with the same name) afresh from the + tip of "master". + +Let's look at this example: + + o---o---o---o---o---o---o---o---o---o "next" + / / / / + / a---a---b A / / + / / / / + / / c---c---c---c B / + / / / \ / + / / / b---b C \ / + / / / / \ / + ---o---o---o---o---o---o---o---o---o---o---o "master" + + +A, B and C are topic branches. + + * A has one fix since it was merged up to "next". + + * B has finished. It has been fully merged up to "master" and "next", + and is ready to be deleted. + + * C has not merged to "next" at all. + +We would want to allow C to be rebased, refuse A, and encourage +B to be deleted. + +To compute (1): + + git rev-list ^master ^topic next + git rev-list ^master next + + if these match, topic has not merged in next at all. + +To compute (2): + + git rev-list master..topic + + if this is empty, it is fully merged to "master". + +DOC_END diff --git a/hooks/pre-receive.sample b/hooks/pre-receive.sample new file mode 100644 index 0000000..a1fd29e --- /dev/null +++ b/hooks/pre-receive.sample @@ -0,0 +1,24 @@ +#!/bin/sh +# +# An example hook script to make use of push options. +# The example simply echoes all push options that start with 'echoback=' +# and rejects all pushes when the "reject" push option is used. +# +# To enable this hook, rename this file to "pre-receive". + +if test -n "$GIT_PUSH_OPTION_COUNT" +then + i=0 + while test "$i" -lt "$GIT_PUSH_OPTION_COUNT" + do + eval "value=\$GIT_PUSH_OPTION_$i" + case "$value" in + echoback=*) + echo "echo from the pre-receive-hook: ${value#*=}" >&2 + ;; + reject) + exit 1 + esac + i=$((i + 1)) + done +fi diff --git a/hooks/prepare-commit-msg.sample b/hooks/prepare-commit-msg.sample new file mode 100644 index 0000000..10fa14c --- /dev/null +++ b/hooks/prepare-commit-msg.sample @@ -0,0 +1,42 @@ +#!/bin/sh +# +# An example hook script to prepare the commit log message. +# Called by "git commit" with the name of the file that has the +# commit message, followed by the description of the commit +# message's source. The hook's purpose is to edit the commit +# message file. If the hook fails with a non-zero status, +# the commit is aborted. +# +# To enable this hook, rename this file to "prepare-commit-msg". + +# This hook includes three examples. The first one removes the +# "# Please enter the commit message..." help message. +# +# The second includes the output of "git diff --name-status -r" +# into the message, just before the "git status" output. It is +# commented because it doesn't cope with --amend or with squashed +# commits. +# +# The third example adds a Signed-off-by line to the message, that can +# still be edited. This is rarely a good idea. + +COMMIT_MSG_FILE=$1 +COMMIT_SOURCE=$2 +SHA1=$3 + +/usr/bin/perl -i.bak -ne 'print unless(m/^. Please enter the commit message/..m/^#$/)' "$COMMIT_MSG_FILE" + +# case "$COMMIT_SOURCE,$SHA1" in +# ,|template,) +# /usr/bin/perl -i.bak -pe ' +# print "\n" . `git diff --cached --name-status -r` +# if /^#/ && $first++ == 0' "$COMMIT_MSG_FILE" ;; +# *) ;; +# esac + +# SOB=$(git var GIT_COMMITTER_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p') +# git interpret-trailers --in-place --trailer "$SOB" "$COMMIT_MSG_FILE" +# if test -z "$COMMIT_SOURCE" +# then +# /usr/bin/perl -i.bak -pe 'print "\n" if !$first_line++' "$COMMIT_MSG_FILE" +# fi diff --git a/hooks/push-to-checkout.sample b/hooks/push-to-checkout.sample new file mode 100644 index 0000000..af5a0c0 --- /dev/null +++ b/hooks/push-to-checkout.sample @@ -0,0 +1,78 @@ +#!/bin/sh + +# An example hook script to update a checked-out tree on a git push. +# +# This hook is invoked by git-receive-pack(1) when it reacts to git +# push and updates reference(s) in its repository, and when the push +# tries to update the branch that is currently checked out and the +# receive.denyCurrentBranch configuration variable is set to +# updateInstead. +# +# By default, such a push is refused if the working tree and the index +# of the remote repository has any difference from the currently +# checked out commit; when both the working tree and the index match +# the current commit, they are updated to match the newly pushed tip +# of the branch. This hook is to be used to override the default +# behaviour; however the code below reimplements the default behaviour +# as a starting point for convenient modification. +# +# The hook receives the commit with which the tip of the current +# branch is going to be updated: +commit=$1 + +# It can exit with a non-zero status to refuse the push (when it does +# so, it must not modify the index or the working tree). +die () { + echo >&2 "$*" + exit 1 +} + +# Or it can make any necessary changes to the working tree and to the +# index to bring them to the desired state when the tip of the current +# branch is updated to the new commit, and exit with a zero status. +# +# For example, the hook can simply run git read-tree -u -m HEAD "$1" +# in order to emulate git fetch that is run in the reverse direction +# with git push, as the two-tree form of git read-tree -u -m is +# essentially the same as git switch or git checkout that switches +# branches while keeping the local changes in the working tree that do +# not interfere with the difference between the branches. + +# The below is a more-or-less exact translation to shell of the C code +# for the default behaviour for git's push-to-checkout hook defined in +# the push_to_deploy() function in builtin/receive-pack.c. +# +# Note that the hook will be executed from the repository directory, +# not from the working tree, so if you want to perform operations on +# the working tree, you will have to adapt your code accordingly, e.g. +# by adding "cd .." or using relative paths. + +if ! git update-index -q --ignore-submodules --refresh +then + die "Up-to-date check failed" +fi + +if ! git diff-files --quiet --ignore-submodules -- +then + die "Working directory has unstaged changes" +fi + +# This is a rough translation of: +# +# head_has_history() ? "HEAD" : EMPTY_TREE_SHA1_HEX +if git cat-file -e HEAD 2>/dev/null +then + head=HEAD +else + head=$(git hash-object -t tree --stdin &2 + echo " (if you want, you could supply GIT_DIR then run" >&2 + echo " $0 )" >&2 + exit 1 +fi + +if [ -z "$refname" -o -z "$oldrev" -o -z "$newrev" ]; then + echo "usage: $0 " >&2 + exit 1 +fi + +# --- Config +allowunannotated=$(git config --type=bool hooks.allowunannotated) +allowdeletebranch=$(git config --type=bool hooks.allowdeletebranch) +denycreatebranch=$(git config --type=bool hooks.denycreatebranch) +allowdeletetag=$(git config --type=bool hooks.allowdeletetag) +allowmodifytag=$(git config --type=bool hooks.allowmodifytag) + +# check for no description +projectdesc=$(sed -e '1q' "$GIT_DIR/description") +case "$projectdesc" in +"Unnamed repository"* | "") + echo "*** Project description file hasn't been set" >&2 + exit 1 + ;; +esac + +# --- Check types +# if $newrev is 0000...0000, it's a commit to delete a ref. +zero=$(git hash-object --stdin &2 + echo "*** Use 'git tag [ -a | -s ]' for tags you want to propagate." >&2 + exit 1 + fi + ;; + refs/tags/*,delete) + # delete tag + if [ "$allowdeletetag" != "true" ]; then + echo "*** Deleting a tag is not allowed in this repository" >&2 + exit 1 + fi + ;; + refs/tags/*,tag) + # annotated tag + if [ "$allowmodifytag" != "true" ] && git rev-parse $refname > /dev/null 2>&1 + then + echo "*** Tag '$refname' already exists." >&2 + echo "*** Modifying a tag is not allowed in this repository." >&2 + exit 1 + fi + ;; + refs/heads/*,commit) + # branch + if [ "$oldrev" = "$zero" -a "$denycreatebranch" = "true" ]; then + echo "*** Creating a branch is not allowed in this repository" >&2 + exit 1 + fi + ;; + refs/heads/*,delete) + # delete branch + if [ "$allowdeletebranch" != "true" ]; then + echo "*** Deleting a branch is not allowed in this repository" >&2 + exit 1 + fi + ;; + refs/remotes/*,commit) + # tracking branch + ;; + refs/remotes/*,delete) + # delete tracking branch + if [ "$allowdeletebranch" != "true" ]; then + echo "*** Deleting a tracking branch is not allowed in this repository" >&2 + exit 1 + fi + ;; + *) + # Anything else (is there anything else?) + echo "*** Update hook: unknown type of update to ref $refname of type $newrev_type" >&2 + exit 1 + ;; +esac + +# --- Finished +exit 0 diff --git a/icon128.png b/icon128.png new file mode 100644 index 0000000..fe2cd22 Binary files /dev/null and b/icon128.png differ diff --git a/icon16.png b/icon16.png new file mode 100644 index 0000000..2ecaf1a Binary files /dev/null and b/icon16.png differ diff --git a/icon48.png b/icon48.png new file mode 100644 index 0000000..f708055 Binary files /dev/null and b/icon48.png differ diff --git a/info/exclude b/info/exclude new file mode 100644 index 0000000..a5196d1 --- /dev/null +++ b/info/exclude @@ -0,0 +1,6 @@ +# git ls-files --others --exclude-from=.git/info/exclude +# Lines that start with '#' are comments. +# For a project mostly in C, the following would be a good set of +# exclude patterns (uncomment them if you want to use them): +# *.[oa] +# *~ diff --git a/logo.svg b/logo.svg new file mode 100644 index 0000000..f9f0e36 --- /dev/null +++ b/logo.svg @@ -0,0 +1,18 @@ + + + + + + + + + + + + + + + + + + diff --git a/manifest.json b/manifest.json new file mode 100644 index 0000000..3fd2689 --- /dev/null +++ b/manifest.json @@ -0,0 +1,24 @@ +{ + "name": "SleepyTabs", + "description": "Suspend tabs when not in use", + "homepage_url": "https://sleepytabs.app", + "version": "1.3", + "manifest_version": 3, + "icons": { + "16": "icon16.png", + "48": "icon48.png", + "128": "icon128.png" + }, + "background": { + "service_worker": "service_worker.js" + }, + "permissions": [ + "alarms", + "storage", + "tabs" + ], + "action": { + "default_popup": "popup.html" + }, + "options_page": "options.html" +} diff --git a/options.css b/options.css new file mode 100644 index 0000000..3db6b34 --- /dev/null +++ b/options.css @@ -0,0 +1,70 @@ +html { + padding: 50px; + text-align: center; + font-size: 130%; + white-space: nowrap; +} +body { + margin: 0; +} +table { + width: 100%; + max-width: 1024px; + margin-left: 50%; + transform: translateX(-50%); +} +table tr > td:nth-child(1) { + text-align: right; +} +table tr > td:nth-child(2) { + text-align: left; + width: 100%; +} +table tr:first-child > td { + text-align: center; +} +table td { + padding: 5px 10px; + vertical-align: top; +} +label { + font-weight: bold; + cursor: pointer; +} +button { + outline: none; + border: 2px solid #eee; + background-color: #eee; + color: #222; + height: 45px; + padding: 0 15px; + font-size: 18px; + font-weight: bold; + margin: 45px 10px; + cursor: pointer; + min-width: 150px; + font-weight: 200; +} +button:hover { + border-color: #ccc; + background-color: #ccc; + color: #666; +} +button#save { + background-color: #fff; + color: #4287f5; + border-color: #4287f5; +} +button#save:hover { + background-color: #4287f5; + border-color: #4287f5; + color: #fff; +} +input[type=text], select, textarea { + min-width: 250px; + width: 100%; + height: 45px; +} +textarea { + height: 125px; +} diff --git a/options.html b/options.html new file mode 100644 index 0000000..5071c8f --- /dev/null +++ b/options.html @@ -0,0 +1,57 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

SleepyTabs

+
Version 1.3
+

(in minutes)		 + +

(one per line)

(one per line)
+ + +
+ + + \ No newline at end of file diff --git a/options.js b/options.js new file mode 100644 index 0000000..2eadc08 --- /dev/null +++ b/options.js @@ -0,0 +1,34 @@ +let delay = document.querySelector('#delay'); +let incognito = document.querySelector('#incognito'); +let audible = document.querySelector('#audible'); +let whitelistPages = document.querySelector('#whitelistPages'); +let whitelistDomains = document.querySelector('#whitelistDomains'); +let btnCancel = document.querySelector('#cancel'); +let btnSave = document.querySelector('#save'); + +chrome.runtime.sendMessage({type: 'GET_OPTIONS'}, null, (options) => { + delay.value = options.suspendAfterMins; + incognito.checked = options.suspendIncognito; + audible.checked = options.suspendAudible; + whitelistPages.value = options.whitelistPages.join("\n"); + whitelistDomains.value = options.whitelistDomains.join("\n"); +}); + +btnCancel.onclick = () => { + window.close(); +}; + +btnSave.onclick = () => { + let whitelistPagesValue = whitelistPages.value.trim(); + let whitelistDomainsValue = whitelistDomains.value.trim(); + let options = { + suspendAfterMins: delay.value, + suspendIncognito: incognito.value, + suspendAudible: audible.value, + whitelistPages: whitelistPagesValue ? whitelistPagesValue.split("\n") : [], + whitelistDomains: whitelistDomainsValue ? whitelistDomainsValue.split("\n") : [], + }; + chrome.runtime.sendMessage({type: 'SET_OPTIONS', options: options}, () => { + window.close(); + }); +}; diff --git a/popup.css b/popup.css new file mode 100644 index 0000000..7e31080 --- /dev/null +++ b/popup.css @@ -0,0 +1,18 @@ +html, body { + padding: 0; + margin: 0; + font-size: 1em; +} +a { + text-decoration: none; + color: #000; + display: block; + padding: 10px 20px; + border-bottom: 1px solid #999; + background-color: #ccc; + white-space: nowrap; +} +a:hover { + background-color: #999; + color: #fff; +} \ No newline at end of file diff --git a/popup.html b/popup.html new file mode 100644 index 0000000..2cd9a64 --- /dev/null +++ b/popup.html @@ -0,0 +1,18 @@ + + + + + + + Suspend this tab now + Un-suspend this tab now + Suspend other tabs + Un-suspend all tabs + Never suspend page + Remove never suspend page + Never suspend site + Remove never suspend site + Options... + + + \ No newline at end of file diff --git a/popup.js b/popup.js new file mode 100644 index 0000000..d262e37 --- /dev/null +++ b/popup.js @@ -0,0 +1,109 @@ +function getCurrentTab(callback) { + chrome.tabs.query( + { + active: true, + currentWindow: true + }, + (_tabs) => { + callback(_tabs[0]); + } + ); +} + +function getOptions(callback) { + chrome.storage.local.get(['sleepyTabsOptions'], (result) => { + callback(result.sleepyTabsOptions || { + suspendAfterMins: 30, + suspendIncognito: false, + whitelistPages: [], + whitelistDomains: [], + }); + }); +} + +function onClick() { + let _element = this; + getCurrentTab((_tab) => { + switch(_element.className) { + case 'suspend-tab': + chrome.runtime.sendMessage({ + type: 'SUSPEND_TAB', + tab: _tab + }, window.close); + break; + case 'un-suspend-tab': + chrome.runtime.sendMessage({ + type: 'UNSUSPEND_TAB', + tab: _tab + }, window.close); + break; + case 'suspend-other': + chrome.runtime.sendMessage({ + type: 'SUSPEND_OTHER_TABS', + tab: _tab + }, window.close); + break; + case 'un-suspend-all-tabs': + chrome.runtime.sendMessage({ + type: 'UNSUSPEND_ALL_TABS', + tab: _tab + }, window.close); + break; + case 'never-suspend-page': + chrome.runtime.sendMessage({ + type: 'NEVER_SUSPEND_PAGE', + tab: _tab + }, window.close); + break; + case 'remove-never-suspend-page': + chrome.runtime.sendMessage({ + type: 'REMOVE_NEVER_SUSPEND_PAGE', + tab: _tab + }, window.close); + break; + case 'never-suspend-site': + chrome.runtime.sendMessage({ + type: 'NEVER_SUSPEND_DOMAIN', + tab: _tab + }, window.close); + break; + case 'remove-never-suspend-site': + chrome.runtime.sendMessage({ + type: 'REMOVE_NEVER_SUSPEND_DOMAIN', + tab: _tab + }, window.close); + break; + } + }); +}; + +document.querySelectorAll('a[href="#"]').forEach((_element, _index) => { + _element.onclick = onClick; +}); + +let linkSuspendTab = document.querySelector('a.suspend-tab'); +let linkUnSuspendTab = document.querySelector('a.un-suspend-tab'); +let linkSuspendOther = document.querySelector('a.suspend-other'); +let linkUnSuspendAll = document.querySelector('a.un-suspend-all'); +let linkNeverSuspendPage = document.querySelector('a.never-suspend-page'); +let linkRemoveNeverSuspendPage = document.querySelector('a.remove-never-suspend-page'); +let linkNeverSuspendSite = document.querySelector('a.never-suspend-site'); +let linkRemoveNeverSuspendSite = document.querySelector('a.remove-never-suspend-site'); + +getCurrentTab((_tab) => { + getOptions((options) => { + linkSuspendTab.style.display = _tab.url.match(/^chrome-extension:\S+suspended.html/) ? 'none' : 'block'; + linkUnSuspendTab.style.display = linkSuspendTab.style.display == 'none' ? 'block' : 'none'; + if(_tab.url.match(/^chrome/)) { + linkNeverSuspendPage.style.display = 'none'; + linkRemoveNeverSuspendPage.style.display = 'none'; + linkNeverSuspendSite.style.display = 'none'; + linkRemoveNeverSuspendSite.style.display = 'none'; + } else { + linkNeverSuspendPage.style.display = options.whitelistPages.indexOf(_tab.url.replace(/\?.*$/, '')) > -1 ? 'none' : 'block'; + linkRemoveNeverSuspendPage.style.display = linkNeverSuspendPage.style.display == 'none' ? 'block' : 'none'; + linkNeverSuspendSite.style.display = options.whitelistDomains.indexOf(_tab.url.replace(/(^https?:\/\/[^/]+).*$/, '$1')) > -1 ? 'none' : 'block'; + linkRemoveNeverSuspendSite.style.display = linkNeverSuspendSite.style.display == 'none' ? 'block' : 'none'; + } + }); +}); diff --git a/service_worker.js b/service_worker.js new file mode 100644 index 0000000..dcdbe54 --- /dev/null +++ b/service_worker.js @@ -0,0 +1,223 @@ +//----------- +// FUNCTIONS +//----------- +function getInactiveTabs(callback) { + chrome.storage.local.get(['sleepyTabsInactiveTabs'], (result) => { + callback(result.sleepyTabsInactiveTabs || {}); + }); +} + +function getOptions(callback) { + chrome.storage.local.get(['sleepyTabsOptions'], (result) => { + callback(result.sleepyTabsOptions || { + suspendAfterMins: 30, + suspendIncognito: false, + suspendAudible: false, + whitelistPages: [], + whitelistDomains: [], + }); + }); +} + +function inWhitelist(url, options) { + let inWhiteList = false; + options.whitelistPages.every((whitelistUrl, index) => { + if(url.replace(/\?.*$/, '') == whitelistUrl) { + inWhiteList = true; + return false; + } + return true; + }); + if(!inWhiteList) { + options.whitelistDomains.every((whitelistUrl, index) => { + if(url.match(whitelistUrl)) { + inWhiteList = true; + return false; + } + return true; + }); + } + return inWhiteList; +} + +function setInactiveTabs(inactiveTabs, callback) { + chrome.storage.local.set({ + sleepyTabsInactiveTabs: inactiveTabs + }, callback); +} + +function setOptions(options, callback) { + chrome.storage.local.set({ + sleepyTabsOptions: options + }, callback); +} + +function suspendTab(_tab) { + getInactiveTabs((inactiveTabs) => { + let _params = new URLSearchParams(); + _params.append('url', _tab.url); + _params.append('title', _tab.title); + _params.append('favIconUrl', _tab.favIconUrl); + chrome.tabs.update(_tab.id, { + url: 'suspended.html?' + _params + }); + delete inactiveTabs[_tab.id]; + setInactiveTabs(inactiveTabs); + }); +} + +function unSuspendTab(_tab, _updateInactiveTabList = true) { + getInactiveTabs((inactiveTabs) => { + if(_tab.url.match('chrome-extension://' + chrome.runtime.id + '/suspended.html')) { // check if currently suspended + chrome.tabs.sendMessage(_tab.id, {type: 'UNSUSPEND'}, () => { + if(_updateInactiveTabList) { + inactiveTabs[_tab.id] = Date.now(); + setInactiveTabs(inactiveTabs); + } + }); + } + }); +} + +function startAlarm() { + stopAlarm(); // just to make sure it's not already running + setInactiveTabs({}); // re-start timer for inactive tabs + chrome.alarms.create('sleepyTabsAlarm', { + when: Date.now(), + periodInMinutes: 1 + }); +} + +function stopAlarm() { + chrome.alarms.clear('sleepyTabsAlarm'); +} + + +//----------- +// LISTENERS +//----------- + +// check to suspend tabs (once per minute) +chrome.alarms.onAlarm.addListener((alarm) => { + if(alarm.name == 'sleepyTabsAlarm') { + const _currentTime = Date.now(); + getOptions((options) => { + getInactiveTabs((inactiveTabs) => { + chrome.windows.getAll({populate: true}, (_windows) => { + _windows.forEach((_window, _windowIndex) => { + _window.tabs.forEach((_tab, _tabIndex) => { + if(!_tab.active && + !_tab.url.match(/^chrome/) && + !inWhitelist(_tab.url, options) && + !(options.suspendIncognito && _tab.incognito) && + !(options.suspendAudible && _tab.audible)) { + if(!inactiveTabs[_tab.id]) { + inactiveTabs[_tab.id] = _currentTime; + setInactiveTabs(inactiveTabs); + } else if(_currentTime - inactiveTabs[_tab.id] >= options.suspendAfterMins * 60000) { + suspendTab(_tab); + } + } + }); + }); + }); + }); + }); + } +}); + +// remove tab from inactive list when activated +chrome.tabs.onActivated.addListener((activeInfo) => { + getInactiveTabs((inactiveTabs) => { + delete inactiveTabs[activeInfo.tabId]; + setInactiveTabs(inactiveTabs); + }); +}); + +// remove tab from inactive list when removed +chrome.tabs.onRemoved.addListener((tabId, removeInfo) => { + getInactiveTabs((inactiveTabs) => { + delete inactiveTabs[tabId]; + setInactiveTabs(inactiveTabs); + }); +}); + +// listen for messages +chrome.runtime.onMessage.addListener((request, sender, sendResponse) => { + getOptions((options) => { + switch(request.type) { + case 'GET_OPTIONS': + sendResponse(options); + break; + case 'SET_OPTIONS': + setOptions(request.options); + if(options.suspendAfterMins > 0 && request.options.suspendAfterMins == 0) { + stopAlarm(); + } else if(options.suspendAfterMins == 0 && request.options.suspendAfterMins > 0) { + startAlarm(); + } + sendResponse(); + break; + case 'SUSPEND_TAB': + suspendTab(request.tab); + sendResponse(); + break; + case 'UNSUSPEND_TAB': + unSuspendTab(request.tab); + sendResponse(); + break; + case 'SUSPEND_OTHER_TABS': + chrome.tabs.query({windowId: request.tab.windowId}, (_tabs) => { + _tabs.forEach((_tab, _tabIndex) => { + if(_tab.id != request.tab.id && !_tab.url.match(/^chrome/)) { + suspendTab(_tab); + sendResponse(); + } + }); + }); + break; + case 'UNSUSPEND_ALL_TABS': + setInactiveTabs({}); + chrome.tabs.query({windowId: request.tab.windowId}, (_tabs) => { + _tabs.forEach((_tab, _tabIndex) => { + unSuspendTab(_tab, false); + sendResponse(); + }); + }); + break; + case 'NEVER_SUSPEND_PAGE': + options.whitelistPages.push(request.tab.url.replace(/(^.*)\?.*$/, '$1')); + setOptions(options); + sendResponse(); + break; + case 'REMOVE_NEVER_SUSPEND_PAGE': + options.whitelistPages.splice(options.whitelistPages.indexOf(request.tab.url.replace(/(^.*)\?.*$/, '$1'))); + setOptions(options); + sendResponse(); + break; + case 'NEVER_SUSPEND_DOMAIN': + options.whitelistDomains.push(request.tab.url.replace(/(^https?:\/\/[^/]+).*$/, '$1')); + setOptions(options); + sendResponse(); + break; + case 'REMOVE_NEVER_SUSPEND_DOMAIN': + options.whitelistDomains.splice(options.whitelistDomains.indexOf(request.tab.url.replace(/(^https?:\/\/[^/]+).*$/, '$1'))); + setOptions(options); + sendResponse(); + break; + } + }); + return true; +}); + + +//------ +// INIT +//------ +chrome.runtime.onInstalled.addListener(() => { + getOptions((options) => { + if(options.suspendAfterMins > 0) { + startAlarm(); + } + }); +}); diff --git a/suspended.css b/suspended.css new file mode 100644 index 0000000..af27476 --- /dev/null +++ b/suspended.css @@ -0,0 +1,54 @@ +html { + background-color: #222; + color: #eee; + font-size: 130%; + text-align: center; + padding: 75px; +} + +html > img { + margin-bottom: 75px; +} + +button.un-suspend { + border: 2px solid #eee; + outline: none; + background-color: #eee; + color: #222; + height: 60px; + padding: 0 30px; + font-size: 24px; + font-weight: bold; + margin: 45px; + cursor: pointer; +} +button.un-suspend:hover { + background-color: #222; + border-color: #eee; + color: #eee; +} +#url { + color: #eee !important; +} + +a { + color: #fcba03; +} +#donate-area { + position: absolute; + bottom: 100px; + font-weight: 200; + left: 50%; + transform: translateX(-50%); + width: calc(100% - 150px); +} +#donate-area > h2 { + font-size: 250%; + font-weight: 200; +} +#donate-area > h3 { + font-weight: 200; +} +#donate-area > h3 > a { + font-weight: 600; +} diff --git a/suspended.html b/suspended.html new file mode 100644 index 0000000..859dfb4 --- /dev/null +++ b/suspended.html @@ -0,0 +1,22 @@ + + + + + + + +

+ +
+ + + + + \ No newline at end of file diff --git a/suspended.js b/suspended.js new file mode 100644 index 0000000..871e7b6 --- /dev/null +++ b/suspended.js @@ -0,0 +1,36 @@ +let _params = new URLSearchParams(window.location.search); +let img = document.querySelector('img'); +let h1 = document.querySelector('h1'); +let url = document.querySelector('#url'); +let btnUnSuspend = document.querySelector('button.un-suspend'); + +function setFavicon(favImg){ + let headTitle = document.querySelector('head'); + let setFavicon = document.createElement('link'); + setFavicon.setAttribute('rel','shortcut icon'); + setFavicon.setAttribute('href',favImg); + headTitle.appendChild(setFavicon); +} + +function unSuspend() { + if(history.length > 1) { + history.back(); + } else { + location.href = _params.get('url'); + } +} +btnUnSuspend.onclick = unSuspend; + +document.title = _params.get('title') + ' [zzZ]'; +img.src = _params.get('favIconUrl') || 'img/logo.svg'; +setFavicon(_params.get('favIconUrl') || 'img/logo.svg'); +h1.innerText = _params.get('title'); +url.innerText = _params.get('url'); +url.href = _params.get('url'); + +chrome.runtime.onMessage.addListener((message, sender, sendResponse) => { + if(message.type == 'UNSUSPEND') { + sendResponse(); // need to send before un-suspending + unSuspend(); + } +});