Skip to content

Saturday, 18 December 2021

 

https://phabricator.kde.org/source/latte-dock/

Let's welcome Latte Dock v0.10.6 the 6th Official Bug Fix Release of v0.10.x branch!
 
Go get it from, download.kde.org*

Fixes

  • fix build with Qt 5.12
  • initialize windows tracking properly

This is a heads up release in order to fix two important issues introduced with previous 0.10.5 version.


Donations

You can find Latte at Liberapay,     Donate using Liberapay


or you can split your donation between my active projects in kde store.
-----
 
* archive has been signed with gpg key: 325E 97C3 2E60 1F5D 4EAD CF3A 5599 9050 A2D9 110E

 

More KDE apps 🔗

Carl Schwan CarlSchwan 10:00 +00:00
RSS
Featured image of post More KDE apps

KDE is all about the Apps is one of the current goals of the KDE community. Since this goal was choosen and announced in 2019 (remember it’s last year that was ‘normal’), I got a new hobby and it’s improving our apps infrastructure (e.g. apps.kde.org) and developing new KDE apps.

I already talked previously about NeoChat (a Matrix client), Kontrast (a contrast checker), Koko (an image viewer) and Pikasso (a simple Rust-powered drawing app for the Plasma Mobile).

Since then, I have developed a few new applications.

Tokodon

I’ve been using Mastodon since years and very much like the idea behind it and the fediverse in general. It’s a social network that is not controlled by a single big organization with dubious ethics but instead is controlled by many and everyone can decide to host their own instance.

Tokodon is a simple client, I developed for this protocol. This app is still in progress and currently it allows to browser the different timelines (home, federated, global), to look at user profiles, send posts with images and multiple accounts support.

The current most prominent missing features are the notification view, account settings and support for some types of post (e.g. videos, polls, …).

If someone is interested to contribute, I will try to mentor a season of KDE project with the goal to implement a notification view to Tokodon (or any of the other big missing features).

Tokodon
Tokodon

Tokodon mobile view
Tokodon mobile view

Tokodon desktop view
Tokodon desktop view

Link to the code

Hash-o-matic

Hash-o-matic is a straightforward GUI that allows the user to calculate checksums of files without using a terminal utility. It’s a simple application that I mainly developed in two evenings. It allows comparing two files, checking if a file matches a checksum and generating checksums for files.

Aside from that, special care was made to integrate it neatly with KDE. A global menu is exposed to global menu users, in Dolphin you can use a right click action to open a file with Hash-o-matic, the app remembers it’s size and position like most KDE apps and finally, drag-and-dropping files from other apps also works!

I would say that the app is now mostly done, and the only remaining feature that might be added is to allow customizing the hashing algorithms used. Currently, only md5, sha1 and sha512 are available.

Hash-o-matic
Hash-o-matic

Link to the code

Whale

Whale is actually a very simple file explorer using Kirigami, that I have been building for fun. It’s pretty rudimentary. Currently it allows browsing directories and I forked the plasma folder view to implement a right-click menu and file selections. It still needs a lot of work, but immediate plan is too at some point reuse the code I’m writing for Whale and reuse it for Koko (the Plasma Mobile image viewer) folder view.

If someone wants to help or just look at the code, you can find it on my invent profile.

Whale, selection

Kalendar

This summer, I mentored for GSoC for extending a prototype I built earlier this year of a Kirigami-based calendar app using Akonadi as backend. You can read more about it on Claudio Cambra’s blog, who is now maintaining the app.

Kalendar month view

Pelikan

In a similar fashion as Kalendar, I also started working on a small mail client using Kirigami and Akonadi. It currentl kinda works for viewing emails, but unfortunately many aspects of KDE PIM libraries related to emails depend too much on QtWidgets and are as such difficult to integrate in a QML application. I started separating the UI code from the buisness logic, but this is an hardeous task and I’m missing time and motivation.

Here is the current state.

Pelikan
Pelikan

Link to code

Nextcloud talk

I have been using Nextcloud Talk a lot in recent months, so I started writing yet another chat client in Kirigami for it. It’s currently a soft-fork of the sailfishOS client written by a colleague.

The current feature set is very basic and most of the QML frontend code has been based on the code we wrote with Tobias for NeoChat.

Nextcloud Talk
Nextcloud Talk

There is still a lot of work required to fix all the issues and get it to a state where it’s usable for daily usage.

Link to the code

Supporting

If you want to support the development of these applications, I strongly encourage you to donate to the KDE community. These donations help us keep our infrastructure running, including our GitLab instance, our websites, and more. You can donate at https://kde.org/community/donations/.

Friday, 17 December 2021

In the last few years I started to use Telegram as my main messenger, beside good old SMS/e-mail.

I never used WhatsApp as I try to stay away from the Facebook/Meta/… ecosystem.

Telegram seemed like a good choice as a lot of people I know are there and we e.g. mirror our KDE channels often to Telegram for better outreach, too. And all old messengers like ICQ more or less were abandoned by everybody I know including myself ;=)

Unfortunately, during the current pandemic, I met more and more people that went down into the rabbit hole thanks to totally uncontrolled Telegram groups.

Yes, you can say: this is free speech.

It is.

But on the other side, I think it can’t really be tolerated that people start to live in some parallel universe that completely ignores any science/laws/facts of the real world.

Telegram isn’t interested in even deleting the most obvious lies or hate speech that is spread in masses there. Most other platforms at least try to do so. At least this is the impression I came to in the last few months.

I talked with people in person that live in such state of denial and I can’t any longer use some application/network/service that encourages the spreading of such stuff.

Therefore I abandoned my Telegram account this week.

If you want to stay in touch with me via some messenger and not plain good e-mail, I use Signal now, at least this seems to be not as awful as Telegram looks for me now.

My Signal account is: +49 176 235 467 98

I will participate in the KDE & Kate related channels via Matrix, e.g. thanks to NeoChat and other free clients ;=) Should have started to use that since long anyways, after I somehow went away from IRC years ago.

Therefore, if you fail to contact me via Telegram, that is no accident, that is intended, sorry if that might be inconvenient.

tl;dr: Just set the default global theme in /etc/xdg/kdeglobals and your good to go.
In the last years System Settings has been gradually improved with each release featuring more pages being cleaned up, redesigned or even rewritten from scratch. In this process there was also focus on proper state handling, adding ‘Defaults’ button where missing and sensible, adding highlighting of changed settings and making sure that these systems do the correct thing. In this post I will explain how Global Themes factor into this and how their pre-run set-up is now much simpler for distributions starting with Plasma 5.24.

Global Themes as defaults supplier

Disclaimer: The changes described here were not done by me but I wanted to give a full overview and context.

In the past Global Themes and all the other settings were separate and parallel to each other. With the increasing roll out of the “highlight non-default settings” feature this could lead to confusing situations. For example when selecting Breeze Dark global theme, which applies the Breeze Dark color scheme, would mark the color scheme as “changed from default” and the “Defaults” button on the color scheme page would select Breeze Light again even it is reasonable to expect that Breeze Dark should be selected when clicking the button which can be interpreted as “Revert manually changed settings”.

Appearance category in System Settings
Appearance category in System Settings

Another pain point was that it was not obvious which settings would be changed by applying a Global Theme. The pages in the Appearance category are displayed indented under the Global Theme entry in the sidebar to visualize that one one hand a global theme encompasses these options and on the other hand illustrate the parent child relationship between the pages.

This ties also nicely into the solution chosen for the first described issue. Starting with Plasma 5.22 setting defaults are taken from the active global theme. That means when applying Breeze Dark global theme it will still change the color scheme to Breeze Dark but will also change the default color scheme to Breeze Dark. To achieve this Plasma prepends a directory kdedefaults to $XDG_CONFIG_DIRS (see XDG Base Directory Specification) which it creates in your $XDG_CONFIG_HOME (typically ~/.config). This makes it the most important configuration location after your personal config folder. When applying a global theme its settings will be applied and additionally written to files inside kdedefaults. This makes the config system treat them as defaults because they are inside the directory with the highest precedence of all $XDG_CONFIG_DIRS.

Default Global Theme

Without doing any changes breeze is the default global theme. It has the rather uninteresting property that it’s sets most settings to their default value. So when it is the default everything works as it should ot of the box. Ideally it should be possible to select a new default global theme by simply setting the relevant key LookAndFeelPackage in kdeglobals in $XDG_CONFIG_DIRS (usually /etc/xdg/kdeglobals).

However that had the slight problem that it did not quite work. When logging as a new user the settings displayed the correct theme as active but it was not actually applied. To fix this it was needed to switch to another theme and go back again or manually run plasma-apply-lookandfeel. This is of course because nothing actually applied the settings as described in the previous section just the setting which theme should be active was changed.

The good news is that this is now fixed and works nicely in Plasma 5.24. During startup Plasma now checks which global theme is supposed to be active and to which the settings inside the kdedefaults folder belong. If there’s a mismatch, this folder is updated. This way it’s ensured the defaults are correct and correspond to the currently active global theme. In addition on a new user with an empty config, reading will fall back to the defaults and returns the settings of the global theme!

Conclusion

To reiterate changing, setting the default global theme and making sure it’s applied on new users now only requires one thing: Modifying the relevant configuration key - LookAndFeelPackage in the KDE group - in a kdeglobals file somewhere in $XDG_CONFIG_DIRS.

Let’s go for my web review for the week 2021-50.


Rights retention: one small step for academics, one giant leap for global access to knowledge – Walled Culture

Tags: scihub, research, academia, commons, open-access

The rebellion against the academic publishers is still going on. Hopefully this will really change soon. That cartel of publishers needs to go back to its rightful place.

https://walledculture.org/rights-retention-one-small-step-for-academics-one-giant-leap-for-global-access-to-knowledge/


The internet is tricking our brains

Tags: tech, smarthome, gafam, memory, cognition

Interesting research on how relying on digital systems reshape our memory and our perception of our own abilities.

https://www.nbcnews.com/tech/internet/internet-tricking-brains-rcna7193


Windows 11 Officially Shuts Down Firefox’s Default Browser Workaround

Tags: tech, microsoft

Looks like Microsoft is hell bent on pushing Edge. Swallow the Edge pill, will you?

https://www.howtogeek.com/774542/windows-11-officially-shuts-down-firefoxs-default-browser-workaround/


The Matrix is Unreal – fxguide

Tags: tech, 3d

As expected, realtime rendering is now getting extremely close to photorealistic.

https://www.fxguide.com/fxfeatured/the-matrix-is-unreal/


Quaternions: Part 1 - Lior Sinai

Tags: mathematics, 3d

Very good series about quaternions. Really helps to understand them better and go in depth.

https://liorsinai.github.io/mathematics/2021/11/05/quaternion-1-intro.html


Teeing, a hidden gem in the Java API

Tags: tech, programming, java

Nice tip about Java collections. Didn’t know you could collect streams that way, definitely handy.

https://blog.frankel.ch/teeing-java-api/


Pico.css • Minimal CSS Framework for semantic HTML

Tags: tech, frontend, css

Now that looks like a really nice CSS framework. I like the approach with a very limited set of classes and pushing you to focus on semantic.

https://picocss.com/


HTTP/3 is Fast | HTTP/3 is here, and it’s a big deal for web performance. See just how much faster it makes websites! | Request Metrics

Tags: tech, http, benchmarking

Interesting benchmarks on HTTP/3. Clearly fares best at long distances.

https://requestmetrics.com/web-performance/http3-is-fast


Don’t start with microservices – monoliths are your friend – Arnold Galovics

Tags: tech, architecture, microservices, complexity

And that’s why I find hard to swallow that “microservices” is the go to answer from lots of people nowadays when you discuss architecture. There are interesting promises on paper but that requires you to ignore several layers of complexity. It’s likely fine to get there at some point, but bake in all that complexity from the start? I don’t think so.

https://arnoldgalovics.com/microservices-in-production/


Kintsugi – Art of Repair | Traditional Kyoto

Tags: culture, history, japan, repair

Good explanation of how repair turned into an art in Japan. It also shows that imperfections can bring values to an object and are part of its history. It makes each object unique.

https://traditionalkyoto.com/culture/kintsugi/



Bye for now!

Dear digiKam fans and users, After five months of maintenance, the digiKam team is proud to present version 7.4.0 of its open source digital photo manager. This new version arrives after 20 years of developement since the first public 0.1.0, released at Christmas 2001. Here is the list of most important features coming with this release: Showfoto Folder-View and Stack-View Showfoto, the stand alone version of digiKam image editor, comes with a new left sidebar including two tabs to navigate in your local file system and to manage your prefered stack of images to load in application.

Thursday, 16 December 2021

gcompris 2.0

Hi,
We are pleased to announce the release of GCompris 2.0. The educational value and the hours of fun and entertainment it provides children of all ages makes it the perfect present for these festive holidays.

It contains many new and improved activities. Below is a summary of included changes.

New activities:

  • Baby mouse is for children learning to interact with a computer for the first time.
  • Oware is a traditional African strategy game, it can be played against the computer or with a friend.
  • In Path encoding (absolute or relative) children need to give a set of directions to follow a defined path in a grid.
  • Path decoding (absolute or relative) is the opposite. Children have to create the path corresponding to a defined set of directions.
  • In Learn quantities, the goal is to count how many items are needed to represent a quantity.
  • In Learn decimal numbers, children cut units in pieces to learn the concept of decimal numbers.
  • Learn decimal additions and Learn decimal subtractions use the same principles as Learn decimal numbers, but this time to practice these operations.
  • With Ordering numbers, children can practice ordering numbers in ascending or descending order.
  • With Ordering letters, children can practice ordering letters in alphabetical order or in reverse order.
  • Ordering sentences is a step up in which children can practice reading and grammar by sorting out parts of a sentence.
  • Positions is an activity to learn the terms describing the relative position of an object.

Improved activities:

  • Analog electricity has a new set of tutorial level.
  • Programming maze has a new dataset containing loops operations, and its tutorial images are now translated.
  • Magic hat activities have new datasets for younger children.
  • In Solar system we now use Earth days and years as unit for all planets.
  • In Geography activities, all the maps have been redrawn and updated, using better projections and in svg format. We also added new maps for each part of Asia (East, Southeast, South, Central and Western).
  • New images and visual improvements for Hanoï activities, Missing letter, Money activities, Photo hunter, Simple paint and Tangram.
  • We have a new Inkscape extension to help creating svg maps and puzzles (https://invent.kde.org/education/gcompris/-/tree/master/tools/inkscape).

... and many more little fixes and improvements.


On the translation side, GCompris 2.0 contains 33 languages. 26 are fully translated: (Azerbaijani, Albanian, Basque, Brazilian Portuguese, British English, Catalan, Catalan (Valencian), Chinese Traditional, Dutch, Estonian, Finnish, French, Greek, Hebrew, Hungarian, Indonesian, Italian, Lithuanian, Malayalam, Polish, Portuguese, Romanian, Slovenian, Spanish, Swedish, Ukrainian). 7 are partially translated: (German (96%), Norwegian Nynorsk (96%), Belarusian (83%), Macedonian (82%), Breton (80%), Turkish (76%) and Russian (76%)).

As usual you can find packages of this new version for GNU/Linux, Windows, Android, Raspberry Pi and macOS on the download page. This update will also be available soon in the Android Play store, the F-Droid repository and the Windows store.

Thank you all,
Timothée & Johnny

Monday, 23 March 2020

This blog post was not easy to write as it started as a very simple thing intended for developers, but later, when I was digging around, it turned out that there is no good single resource online on copyright statements. So I decided to take this stab at writing one.

I tried to strike a good balance between 1) keeping it short and to the point for developers who just want to know what to do, and 2) FOSS compliance officers and legal geeks who want to understand not just best practices, but also the reasons behind them.

If you are extremely short on time, the TL;DR should give you the bare minimal instructions, but if you have just 2 minutes I would advise you to read the actual HowTo a bit lower below.

Of course, if you have about 20 minutes of time, the best way is always to start reading at the beginning and finish at the end.

Where else to find this article & updates

A copy of this blog is available also on Liferay Blog.
Haksung Jang (장학성) was awesome enough to publish a Korean translation.

2021-03-09 update: better wording; more info on how to handle anonymous authors and when copyright is held by employer, © and ASCII, multiple authors; DCO; easier REUSE instructions

2022-10-23 update: more FAQ entries

2023-03-28 update: a few more FAQ entries following feedback at FOSDEM and from Mastodon

TL;DR

Use the following format:

SPDX-FileCopyrightText: © {$year_of_file_creation} {$name_of_copyright_holder} <{$contact}>

SPDX-License-Identifier: {$SPDX_license_name}

… put that in every source code file and go check out (and follow) REUSE.software best practices, published by the FSFE.

E.g. for a file that I created today and I released under the BSD-3-Clause license, I would use put the following as a comment at the top of the source code file:

SPDX-FileCopyrightText: © 2020 Matija Šuklje <matija@suklje.name>

SPDX-License-Identifier: BSD-3-Clause

Introduction and copyright basics

Copyright is automatic (since the Berne convention) and any work of authorship is automatically protected by it – essentially giving the copyright holder1 exclusive power over their work. In order for your downstream to have the rights to use any of your work – be that code, text, images or other media – you need to give them a license to your work.

So in order for you to copy, implement, modify etc. the code from others, you need to be given the needed rights – i.e. a license2 –, or make use of a statutory limitation or exception3. And if that license has some obligations attached, you need to meet them as well.

In any case, you have to meet the basic requirements of copyright law as well. At the very least you need to have the following two in place:

  • attribution – list the copyright holders and/or authors – especially in jurisdictions which recognise moral rights (e.g. most of EU) it is important to keep the names of authors, if they are listed;
  • license(s) – since a license is the only thing that gives anybody other than the copyright holder themself the right to use the code, you are very well advised to have a notice of the the license and its full text present – this goes for both for your outbound licenses and the inbound licenses you received from others by using 3rd party works, such as copied code or libraries.

Inbound vs. outbound licenses

The license you give to your downstream is called an outbound license, because it handles the rights in the code that flow out of you. In turn that same license in the same work would then be perceived by your downstream as their inbound license, as it handles the rights in the code that flows into them.

In short, licenses describing rights flowing in are called inbound licenses, and the licenses describing rights flowing out are called outbound licenses.

The good news is that attribution is a discretionary right that can be exercised by the author should they choose to. And you are obliged to keep the attribution notices only insofar as the author(s) made use of that right. Which means that if the author has not listed themselves, you do not have to hunt them down yourself.

Why have the copyright statement?

Which brings us to the question of whether you need to write your own copyright statement4.

First, some very brief history …

The urge to absolutely have to write copyright statements stems from the inertia in the USA, as it only joined the Berne convention in 1989, well after computer programs were a thing. Which means that before then the US copyright law still required an explicit copyright statement in order for a work to be protected.

Copyright statements are useful

The copyright statement is not required by law, but in practice very useful as proof, at best, and indicator, more likely, of what the copyright situation of that work is. This can be very useful for compliance reasons, traceability of the code etc.

Attribution is practically unavoidable, because a) most licenses explicitly call for it, and if that fails b) copyright laws of most jurisdictions require it anyway.

And if that is not enough, then there is also c) sometimes you will want to reach the original author(s) of the code for legal or technical reasons.

So storing both the name and contact information makes sense for when things go wrong. Finding the original upstream of a runaway file you found in your codebase – if there are no names or links in it – is a huge pain and often includes (currently still) expensive specialised software. I would suspect the onus on a FOSS project to be much lower than on a corporation in this case, but still better to put a little effort upfront than having to do some serious archæology later.

How to write a good copyright statement and license notice

Finally we come to the main part of this article!

A good copyright statement should consist of the following information:

  • start with the © sign;
  • the year of the first publication – a good date would be the year in which you created the file and then do not touch that date anymore;
  • the name of the copyright holder – typically the author, but depending on the circumstances might be their employer or if there is a CLA in place the legal entity or person they transferred their rights to;
  • a valid contact to the copyright owner

As an example, this is what I would put on something I wrote today:

© 2020 Matija Šuklje <matija@suklje.name>

While you are at it, it would make a lot of sense to also notify everyone which license you are releasing your code under as well. Using an SPDX ID is a great way to unambiguously state the license of your code. (See note mentioned below for an example of how things can go wrong otherwise.)

And if you have already come so far, it is just a small step towards following the best practices as described by REUSE.software by using SPDX tags to make your copyright statement (marked with SPDX-FileCopyrightText) and license notice (marked with SPDX-License-Identifier and followed by an SPDX ID).

Here is now an example of a copyright statement and license notice that check all the above boxes and also complies with both the SPDX and the REUSE.software specifications:

SPDX-FileCopyrightText: © 2020 Matija Šuklje <matija@suklje.name>

SPDX-License-Identifier: BSD-3-Clause

Now make sure you have these in comments of all your source code files.

Q&A

Over the years, I have heard many questions on this topic – both from developers and lawyers.

I will try to address them below in no particular order.

If you have a question that is not addressed here, do let me know and I will try to include it in an update.

Why keep the year?

Some might argue that for the sake of simplicity it would be much easier to maintain copyright statements if we just skip the years. In fact, that is a policy at Microsoft/GitHub at the time of this writing.

While I agree that not updating the year simplifies things enormously, I do think that keeping a date helps preserve at least a vague timeline in the codebase. As the question is when the work was first expressed in a medium, the earliest date provable is the time when that file was first created.

In addition, having an easy way to find the earliest date of a piece of code, might prove useful also in figuring out when an invention was first expressed to the general public. Something that might become useful for patent defense.

This is also why e.g. in Liferay our new policy is to write the year of the file creation, and then not change the year any more.

Innocent infringement excursion for legal geeks

17 U.S. Code § 401.(d) states that if a work carries a copyright notice in the form that the law prescribes, in a copyright infringement case the defendant cannot rely on the innocent infringement defense, except if they had reason to believe their use was covered fair use. And even then, the innocent infringer would have to be e.g. a non-profit broadcaster or archive to be still eligible to such defence.

So, if you are concerned with copyright violations (at least in USA), you may actually want to make sure your copyright statements include both the copyright sign and year of publication.

See also note in Why the © sign for how a copyright notice following the US copyright act looks like.

Why not bump the year on change?

I am sure you have seen something like this before:
Copyright (C) 1992, 1995, 2000, 2001, 2003 CompanyX Inc.

The presumption behind this is that whenever you add a new year in the copyright statement, the copyright term would start anew, and therefore prolong the time that file would be protected by copyright.

Adding a new year on every change – or, even worse, simply every 1st January – is a practice still too wide-spread even today. Unfortunately, doing this is useless at best, and misleading at worst. Needless to say, if you do this as part of your build process, this is extra wrong. For the origin of this myth see the short history above.

A big problem with this approach is that not every contribution is original or substantial enough to be copyrightable – even the popular 5 (or 10, or X) SLOC rule of thumb5 is legally-speaking very debatable.

So, in order to keep your copyright statement true, you would need to make a judgement call every time whether the change was substantial and original enough to be granted copyright protection by the law and therefore if the year should be bumped. And that is a substantial test for every time you change a file.

On the other hand copyright lasts at least 50 (and usually 70) years6 after the death of the author; or if the copyright holder is a legal entity (e.g. CompanyX Inc.), since publication. So the risk of your own copyright expiring under your feet is very very low.

Worst case thought experiment

Let us imagine the worst possible scenario now:

1) you never bump the year in a copyright statement in a file and 2) 50+ years after its initial release, someone copies your code as if it were in public domain. Now, if you would have issue with that and go to court, and 3) the court would (very unlikely) take only the copyright statements in that file into account as the only proof and based on that 4) rule that the code in that file would have fallen under public domain and therefore the FOSS license would not apply to it any more.

The end result would simply be that (in one jurisdiction) that file would fall into public domain and be up for grabs by anyone for anything, no copyright, no copyleft, 50+ years from the file’s creation (instead of e.g. 5, maybe 20 years later).

But, honestly, how likely is it that 50 years from now the same (unaltered) code would still be (commercially) interesting?

… and if it turns out you do need to bump the year eventually, you still have, at worst, 50 years to sort it out – so, ample opportunity to mitigate the risk.

In addition to that, as typically a single source code file is just one of the many cogs in a bigger piece of software, what you are more concerned with is the software product/project as a whole. As the software grows, you will keep adding new files, and those will obviously have newer years in them. So the codebase as a whole work will already include copyright statements with newer years in it anyway.

Keep the Git/VCS history clean

Also, bumping the year in all the files every year messes with the usefulness of the Git/VCS history, and makes the log unnecessarily long(er) and the repository consumes more space.

It makes all the files seem equally old (in years), which makes it hard to identify stale code if you are looking for it.

Another issue might be that your year-bumping script can be too trigger-happy and bump the years also in the files that do not even belong to you. Furthering misinformation both in your VCS and the files’ copyright notices.

Do not bump the year during build time

Bumping the year manually is bad, but automating year bumping during build time is taking it to another level!

One could argue – and I suspect this is where it originates from – that since compiling is translation and as such an exclusive right of the copyright holder. But while translation from one programming language to another clearly can take a lot of mental effort and might require different ways how to express something, a machine-compilation from human-readable source code to machine-readable object/binary code per se is extremely unlikely to have added a new copyrightable component into the mix. That would be like saying an old song would gain new copyright just because it was released in a new audio format without any other changes.

Bumping the year during build time also messes up reproducible builds.

Why not use a year range?

Similar to the previous question, the year span (e.g. 1990-2013) is basically just a lazy version of bumping the year. So all of the above-mentioned applies.

A special case is when people use a range like {$year}-present. This has almost all of the above-mentioned issues7, plus it adds another dimension of confusion, because what constitutes the “present” is an open – and potentially philosophical – question. Does it mean:

  • the time when the file was last modified?
  • the time it was released as a package?
  • the time you downloaded it (maybe for the first time)?
  • the time you ran it the last time?
  • or perhaps even the ever eluding “right now”?

As you can see, this does not help much at all. Quite the opposite!

But doesn’t Git/Mercurial keep a better track?

Not reliably.

Git (and other VCS) are good at storing metadata, but you should be careful about it.

Git does have an Author field, which is separate from the Committer field. But even if we were to assume – and that is a big assumption8 – Git’s Author was the actual author of the code committed, they may not be the copyright holder.

Furthermore, the way git blame and git diff currently work, is line-by-line and using the last change as the final author, making Git suboptimal for finding out who actually wrote what.

Token-based blame information

For a more fine-grained tool to see who to blame for which piece of code, check out cregit.

And ultimately – and most importantly – as soon as the file(s) leave the repository, the metadata is lost. Whether it is released as a tarball, the repository is forked and/or rebased, or a single file is simply copied into a new codebase, the trace is lost.

All of these issues are addressed by simply including the copyright statement and license information in every file. REUSE.software best practices handle this very well.

Why the © sign?

Some might argue that the English word “Copyright” is so common nowadays that everyone understands it, but if you actually read the copyright laws out there, you will find that using © (i.e. the copyright sign) is the only way to write a copyright statement that is common in copyright laws around the world9.

Using the © sign makes sense, as it is the the common global denominator.

Comparison between US and Slovenian copyright statements

As an EU example, the Slovenian ZASP §175.(1) simply states that holders of exclusive author’s rights may mark their works with a (c)/© sign in front of their name or firm and year of first publication, which can be simply put as:

© {$year_of_first_publication} {$name_of_author_or_other_copyright_holder}

On the other side of the pond, in the USA, 17 U.S. Code § 401.(b) uses more words to give a more varied approach, and relevant for this question in §401(b)(1) prescribes the use of

the symbol © (the letter C in a circle), or the word “Copyright”, or the abbreviation “Copr.”;

The rest you can go read yourself, but can be summarised as:

(©|Copyright|Copr.) {$year_of_first_publication} {$name_or_abreviation_of_copyright_holder}

See also the note in Why keep the year for why this can matter in front of USA courts.

While the © sign is a pet peeve of mine, from the practical point of view, this is the least important point here. As we established in the introduction, copyright is automatic, so the actual risk of not following the law by its letter is pretty low if you write e.g. “Copyright” instead.

© sign and ASCII

While Unicode (UTF-8, UTF-16, …) is pretty much ubiquitous nowadays, there are places and reasons for when the encoding of source code will have to be limited to a much simpler one, such as ASCII. This could be e.g. in case when the code is written to be put into small embedded devices where every bit counts.

The © character was introduced in 8-bit extended ASCII, but the original 7-bit ASCII does not have it.

So if this is the situation you are in, it is fine to either ommit the copyright sign or replace it with e.g. (C) or Copyright.

Why leave a contact?

A contact is in no way required by copyright law, but from practical reasons can be extremely useful.

It can happen that you need to access the author and/or copyright holder of the code for legal or technical question. Perhaps you need to ask how the code works, or have a fix you want to send their way. Perhaps you found a licensing issue and want to help them fix it (or ask for a separate license). In all of these cases, having a contact helps a lot.

As pretty much all of internet still hinges on the e-mail10, the copyright holder’s e-mail address should be the first option. But anything really goes, as long as that contact is easily accessible and actually in use long-term.

Avoiding orphan works

For the legal geeks out there, a contact to the copyright holder mitigates the issue of orphan works.

There will be cases where the authorship will be very dispersed or lie with a legal entity instead. In those cases, it might be more sense to provide a URL to either the project’s or legal entity’s homepage and provide useful information there. If a project lists copyright holders in a file such as AUTHORS or CONTRIBUTORS.markdown a permalink to that file (in the master) of the publicly available repository could also be a good URL option.

How to handle multitudes of authors?

Here are two examples of what you can write in case the project (e.g. Project X) has many authors and does not have a CAA or exclusive CLA in place to aggregate the copyright in a single entity:

© 2010 The Project X Authors <https://projectx.example/about/authors>

© 1998 Contributors to the Project X <https://git.projectx.example/ProjectX/blob/master/CONTRIBUTORS.markdown>

An an example of when the project is handled by a non-profit NGO legal entity.

© 2020 BestProjectNGO <https://bestprojectngo.example>

Bot to automate contributions

A really interesting project is All Contributors, which specifies how to manage contributions to all – even non-code – contributions to a project. It also includes a CLI tool and offers a GitHub bot to automate this process.

The major downside is that the prescribed format is an HTML table embedded in MarkDown. So not very easy to read or parse in source form.

What if I added code to an existing project?

A major benefit of FOSS is that people collaborate on the same project, so it is inevitable that several people will be touching the same file. If that file already includes a copyright statement, this is a good question.

If there are only a handful of people who wrote that file, it would be fine to just add a new line with your copyright statement, as such:

SPDX-FileCopyrightText: © 2018 Matija Šuklje <matija@suklje.name>
SPDX-FileCopyrightText: © 2021 Master Hacker <mh@example.org>

But if there are many authors that would need to be added that way, to avoid clutter, it would make sense to instead create an AUTHORS.* or CONTRIBUTORS.* file as described in the question above.

What about public domain?

Public domain is tricky.

In general the public domain are works to which the copyright term has expired11.

While in some jurisdictions (e.g. USA, UK) you can actually waive your copyright and dedicate your work to public domain, in most jurisdiction (e.g. most of EU member countries) that is not possible.

Which means that depending on the applicable jurisdiction, it may be that although an author wrote that they dedicate their work into public domain this does not meet the legal standard for it to actually happen – they retain the copyright in their own work.

Unsurprisingly, FOSS compliance officers and other people/projects who take copyright and licensing seriously are typically very wary of statements like “this is public domain”.

This can be mitigated in two ways:

  • instead of some generic wording, when you want to dedicate something to public domain use a tried and tested public copyright waiver / public domain dedication with a very permissive license, such as 0BSD for code or CC0-1.0 for non-code; and
  • include your name and contact if you are the author in the SPDX-FileCopyrightText: field – 1) because in doubt that will associate you with your dedication to the public domain, and 2) in case anything is unclear, people have a contact to you.

This makes sense to do even for files that you deem are not copyrightable, such as config files – if you mark them as above, everyone will know that you will not exercise your author’s rights (if they existed) in those files.

It may seem a bit of a hassle for something you just released to the public to use however they see fit, without people having to ask you for permission. I get that, I truly do! But do consider that if you already put so much effort into making this wonderful stuff you and donating it to the general humanity, it would be a huge pity that, for (silly) legal details, in the end people would not (be able to) use it at all.

What about minified JS?

Modern code minifiers/uglifiers tend to have an optional flag to preserve copyright and licensing info, even when they rip out all the other comments.

The copyright does not simply go away if you minify/uglify the code, so do make sure that you use a minifier that preserves both the copyright statement as well as the license (at least its SPDX Identifier) – or better yet, the whole REUSE-compliant header.

Transformations of code

Translations between different languages, compilations and other transformations are all exclusive rights of the copyright owner. So you need a valid license even for compiling and minifying.

What is wrong with “All rights reserved”?

Often you will see “all rights reserved” in copyright statements even in a FOSS project.

The cause of this, I suspect, lies again from a copycat behaviour where people tend to simply copy what they so often found on a (music) CD or in a book. Again, the copyright law does not ask for this, even if you want to follow the fullest formal copyright statement rules.

But what it does bring, is confusion.

The statement “all rights reserved” obviously contradicts the FOSS license the same file is released under. The latter gives everyone the rights to use, study, share and improve the code, while the former states that all of these rights the author reserves to themself.

So, as those three words cause a contradiction, and do not bring anything useful to the table in the first place, you should not write them in vain.

Practical example

Imagine12 a FOSS project that has a copy of the MIT license stored in its LICENSE file and (only) the following comment at the top of all its source code files:

# This file is Copyright (C) 1997 Master Hacker, all rights reserved.

Now imagine that someone simply copies one file from that repository/archive into their own work, which is under the AGPL-3.0-only license, and this is also what it says in the LICENSE file in the root of its own repository. And you, in turn, are using this second person’s codebase.

According to the information you have at hand:

  • the copyright in the copied file is held by Master Hacker;
  • apparently, Mr Hacker reserves all the rights they have under copyright law;
  • if you felt like taking a risk, you could assume that the copied file is under the AGPL-3.0-or-later license – which is false, and could lead to copyright violation13;
  • if you wanted to play it safe, you could assume that you have no valid license to this file, so you decide to remove it and work around it – again false and much more work, but safe;
  • you could wait until 2067 and hope this actually falls under public domain by then – but who has time for that.

This example highlights both how problematic the wording of “all rights reserved” can be even if there is a license text somewhere in the codebase.

This can be avoided by using a sane copyright statement (as described in this blog post) and including an unambiguous license ID. REUSE.software ties both of these together in an easy to follow specification.

What if I work for a company, NGO, university?

In many jurisdictions if you are in an employment relationship (at least full employment), your employer would be the one holding the relevant rights.

If the revelant jurisdiction is Slovenian (as an EU example), ZASP §101 (unofficial English translation) says the following:

(1) When copyright work is created by an employee in the execution of his duties or following the instructions given by his employer (copyright work created in the course of employment), it shall be deemed that the economic rights and other rights of the author to such work are exclusively assigned to the employer for the period of ten years from the completion of the work, unless otherwise provided by contract.

(2) On the expiration of the term mentioned in the foregoing paragraph, the rights mentioned in the foregoing paragraph revert to the employee, however, the employer can claim a new exclusive assignment of these rights, for adequate remuneration.

If the relevant jurisdiction is USA this would fall under “work for hire” and the employer would be the copyright holder of any work their employee makes that are within the scope of their employment. There are also other cases where “work for hire” kicks in, but the sloppy rule of thumb is that if the closer the work’s creation was controlled by the employer/hiring party, the more likely it would be the copyright holder.

In any case, if your contract says you are transferring the rights to your employer or the other party, then they would be the copyright holder (e.g. in USA) or at least the exclusive rights holder (e.g. most of EU).

On a similar note, an author / copyright holder / exclusive right holder can transfer the rights they have to another person by written agreement.

What if I want to stay anonymous?

Whether you want to sign your work with your legal name, a pseudonym14 or even not at all is your own decision as author.

But do take into consideration that if you want to stay anonymous, you will have a much harder time proving you are the author of that piece of code later. For this reason, it would make sense to release your anonymous code under a “public-domain-like” license such as CC0-1.0 or Unlicense.

In any case, unless you have good reasons not to (e.g. for your personal safety), it would be really useful to use the copyright tag to at least include a contact. In case you want to just use a pseudonym, that should not be much of an issue. But in the case you want to stay anonymous, the contact could be simply the URL to the project’s homepage and instead of your name you could state the name of the project, or leave it empty.

Anonymity and Git

If you are concerned about anonymity, do take into consideration also that Git stores both author and committer data for each commit. Look into how to keep those records in a way that they cannot be linked to you.

My project uses DCO. Does this conflict with it?

Not at all. Quite the opposite!

When signing the DCO 1.1, you state that you are contributing under the license as stated in the file. If the file you contributed (to), includes an SPDX license tag, that supports the DCO.

While signing the DCO typically requires you to use git commit --signoff when you commit, so it stores your agreement with DCO in the repository history, if a file is copied outside that git repository that information, along with your authorship information is lost. So it makes sense to include your copyright statement and contact in each file even if you sign a DCO.

How do I find out the date of file creation?

If you are creating a new file, this is trivial, as you just need to enter the current year (e.g. with date +Y).

But if you are adding your copyright statements to your existing software, that might indeed be a bit more tricky.

Luckily, if your project uses a VCS and all its history is tracked in it, you can find the date of the first commit for each file. If using Git, the following command will output you the year the file was first authored:

git log --follow --format=%as {$path} | tail -n1 | cut -c-4

Failing that, you could check with your filesystem (e.g. for EXT4), but this can be of very questionable quality, if you know the file landed on your disk at a later date, you changed disks etc.

If even that is not a viable possibility, just use your best judgement.

That is a tricky question, and probably depends on the jurisdiction in question.

This analysis tries to answer those questions from the Slovenian jurisdiction.

What about if I merge or split a file or just use a snippet?

In case you copy just a part of a file (assuming that part is copyrightable) into another file, you can put retain/copy its licensing metadata by wrapping its SPDX/REUSE tags between an SPDX-SnippetBegin and an SPDX-SnippetEnd tag. For more details see the Snippet tags format annex of the SPDX specification.

An example would se as follows:

# SPDX-SnippetBegin

# SPDX-FileCopyrightText: © 2020 Matija Šuklje <matija@suklje.name>
# SPDX-License-Identifier: BSD-3-Clause

...
import sense
lots_of_cool_code()
...

# SPDX-SnippetEnd

You can use this also when e.g. concattenating different JS files into one.

In any case, unless you are the copyright holder, do not remove or alter other people’s copyright statements. You can always add a new one, if it is needed.

hook out → hat tip to the TODO Group for giving me the push to finally finish this article and Carmen Bianca Bakker, Robbie Morrison, as well as the Legal Network for some very welcome feedback


  1. This is presumed to be the author at least initially. But depending on circumstances can be also some other person, a legal entity, a group of people etc. See also this FAQ entry for more info. 

  2. A license is by definition “[t]he permission granted by competent authority to exercise a certain privilege that, without such authorization, would constitute an illegal act, a trespass or a tort.” 

  3. Limitations and exceptions (or fair use/dealings in USA/Canada/UK) in copyright are extremely limited when it comes to software compared to more traditional media. Do not rely on them. 

  4. In USA, the copyright statement is often called a copyright notice. The two terms are used intercheangably. 

  5. E.g. the 5 SLOC rule of thumb means that any contribution that is 5 lines or shorter, is (likely) too short to be deemed copyrightable, and therefore can be treated as un-copyrightable or as in public domain; and on the flip-side anything longer than 5 lines of code needs to be treated as copyrightable. This rule can pop up when a project has a relatively strict contribution agreement (a CLA or even CAA), but wants some leeway to accept short fix patches from drive-by contributors. The obvious problem with this is that on one hand someone can be very original even in 5 lines (think haiku), while one can also have pages and pages of absolute fluff or just plain raw factual numbers. 

  6. This depends from jurisdiction to jurisdiction. The Berne convention stipulates at least 50 years after death of the author as the baseline. There are very few non-signatory states that have shorter terms, but the majority of countries have life + 70 years. The current longest copyright term is life + 100 years, in Mexico. 

  7. The only improvement is that it avoids messing up the Git/VCS history. 

  8. In practice what the Author field in a Git repository actually includes varies quite a bit and depends on how the committer set up and used Git. 

  9. Of course, I did not go through all of the copyright laws out there, but I checked a handful of them in different languages I understand, and this is the pattern I identified. If anyone has a more thorough analysis at hand, please reach out and I will happily include it. 

  10. Just think about it, pretty much every time you create a new account somewhere online, you are asked for your e-mail address, and in general people rarely change their e-mail address. 

  11. As stated before, in most jurisdictions that is 70 years after the death of the author. 

  12. I suspect many of the readers not only can imagine one, but have seen many such projects before ;)

  13. Granted, MIT code embedded into AGPL-3.0-or-later code is less risky than vice versa. But simply imagine what it would be the other way around … or with an even odder combination of licenses. 

  14. A(n identifiable) pseudonym, under copyright law, has basically the same power as a legal name. Think of all the musicians, actors and writers that we know under their pseudonym or stage name. 

Monday, 9 May 2016

 

wikitolearn
WikiToLearn

 

On May 5th night, we had a hangout call with our project mentors and other GSoC students of WikiToLearn team.
This is the first hangout call we had with respect to GSoC.

We discussed the following things :

* Having a blog account and keep updating the progress in it. Also to find a way to mirror our blog and WikiToLearn wiki page to keep track of everything.

* Gianluca explained about the need of KDE account, Phabricator.

* All our current source code are hosted on Github, we may move to KDE QuickGit someday soon.

* We discussed our project proposals. We felt it will be a good idea if we inform about our project ideas to upstream contributors, MediaWiki contributors so that they could help us if we have any problem with respect to MediaWiki extension development.

* Make use of WikiToLearn tech channel effectively for every technical problem because we have experienced people there who could help us to solve it.

Things which I have done till now :

* Created an account on KDE identity.

* Got KDE developer access.

* Aggregated my Blog with KDE planet.

* Have an account on Phabricator.

* Have an account on KDE Bugtracking System. (WikiToLearn team doesn’t use it much.)

* Updated my user page on WikiToLearn.

* Created a doc which shows a list of days and hours I’ll be working/taking off.

* Running MediaWiki instance locally in my system.

* Installed and enabled VisualEditor. (Playing with it)

* Spending some amount of time in configuring Parsoid server. (I need to link VisualEditor and Parsoid server so that they talk each other and enables me to create and save wiki pages.)

 

VisualEditor
MediaWiki with VisualEditor

Things I’ll work on next :

* Configure Parsoid server.

* Design workflow scheme for collaborative editor extension.

* Try out some simple VE extensions.

 

Friday, 22 April 2016

gsoc-2016

Something I’ve wanted to say for more than a year. Yes! I am a GSoCer now!
This was one among my biggest dreams. 🙂

GSoC – Google Summer of Code is an annual program, in which Google awards healthy stipends to students for contributing to Open Source projects.

All these days, I was spending most of my time fixing bugs on different open source projects. Now I have got the opportunity to work with WikiToLearn,  a proud member of KDE community, for a long period of time, implementing a new feature to wiki editor.

I would like to tell a bit about our WikiToLearnWikiToLearn wants to provide free, collaborative and accessible textbooks to the whole world.
Our philosophy is synthesized in the sentence: “knowledge only grows if shared”. We provide a platform where learners and teachers can together complete, refine and re-assemble notes, lecture notes in order to create textbooks, tailored precisely to their needs so that you can “stand on the shoulders of giants”.

I should thank my mentors Cristian Baldi, Gianluca Rigoletti  and other community members for helping me in reviewing and getting a great project proposal done. I’m really excited to work with them this summer. 🙂

Looking at previous GSOCers like Sayan, Sagar, Vignesh, Parth was always motivating me to contribute to open source and become a GSoCer.
I thank F.S.M.K, DGPLUG, and our GLUG-DSCE which taught me a lot about free/open source technologies.

More love to WikiToLearn  folks for giving me this opportunity to work with them. 🙂

 

You can have a look at my proposal abstract here.
Soon I’ll push my complete project proposal on GitHub.

The real fun begins now. 🙂