Compare commits
22 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 3caf592756 | |||
| 0a464db214 | |||
| 2de0dc19a0 | |||
| 405c7d2431 | |||
| b4b7ef74d6 | |||
| eac8617723 | |||
| 3e0cf10d6c | |||
| 524f293e37 | |||
| 5ba4029912 | |||
| 305ee59477 | |||
| 7fde8cb3d9 | |||
| d463faf134 | |||
| 974a3ae8bd | |||
| 0833c4a1c0 | |||
| d2383a76b7 | |||
| 6328f3632f | |||
| 6c23c4aeb2 | |||
| 2c9ef4ce7d | |||
| b25316e58f | |||
| 736bf1eac5 | |||
| 01af36d8c1 | |||
| 2d5c6a1377 |
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
|||||||
|
PLAN-*
|
||||||
99
Asset/css/finance.css
Normal file
99
Asset/css/finance.css
Normal file
@@ -0,0 +1,99 @@
|
|||||||
|
/*
|
||||||
|
* FinanceBuddy styles.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/* The column header (.board-column-expanded-header) is a flex row, so the total is a flex item. To
|
||||||
|
drop it onto its own line under the title, let that header wrap (scoped with :has to headers that
|
||||||
|
actually contain the total -- i.e. enabled boards only) and give the total full width. No
|
||||||
|
background (dropped per request); "Total:" stays black, only the amount span is colored by sign. */
|
||||||
|
.board-column-expanded-header:has(.fb-column-total) {
|
||||||
|
flex-wrap: wrap;
|
||||||
|
}
|
||||||
|
|
||||||
|
.fb-column-total {
|
||||||
|
flex-basis: 100%;
|
||||||
|
margin-top: 2px;
|
||||||
|
text-align: right;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* The visible pill hugs the text (not the full width) and is right-justified on its line. */
|
||||||
|
.fb-total-pill {
|
||||||
|
display: inline-block;
|
||||||
|
padding: 0 5px;
|
||||||
|
font-weight: bold;
|
||||||
|
font-size: 0.95em;
|
||||||
|
color: #000;
|
||||||
|
background: rgba(0, 0, 0, 0.05);
|
||||||
|
border-radius: 3px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Keep the signed amount together ("-R$450,00"); a break before it (after "Total:") is fine. */
|
||||||
|
.fb-amount {
|
||||||
|
white-space: nowrap;
|
||||||
|
}
|
||||||
|
|
||||||
|
.fb-total-debit {
|
||||||
|
color: #b94a48;
|
||||||
|
}
|
||||||
|
|
||||||
|
.fb-total-credit {
|
||||||
|
color: #468847;
|
||||||
|
}
|
||||||
|
|
||||||
|
.fb-total-zero {
|
||||||
|
color: #777;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Line-3 money badge on board cards. Its own background guarantees contrast on any card color. */
|
||||||
|
.fb-line {
|
||||||
|
margin: 2px 0 4px;
|
||||||
|
line-height: 1.4;
|
||||||
|
}
|
||||||
|
|
||||||
|
.fb-badge {
|
||||||
|
display: inline-block;
|
||||||
|
padding: 1px 6px;
|
||||||
|
border-radius: 3px;
|
||||||
|
color: #fff;
|
||||||
|
font-weight: bold;
|
||||||
|
font-size: 1.1em;
|
||||||
|
white-space: nowrap;
|
||||||
|
}
|
||||||
|
|
||||||
|
.fb-badge-debit {
|
||||||
|
background: #b94a48;
|
||||||
|
}
|
||||||
|
|
||||||
|
.fb-badge-credit {
|
||||||
|
background: #468847;
|
||||||
|
}
|
||||||
|
|
||||||
|
.fb-installments {
|
||||||
|
margin-left: 6px;
|
||||||
|
color: #000;
|
||||||
|
font-size: 1.05em;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Task-form finance fieldset (middle column). */
|
||||||
|
.fb-form-directions {
|
||||||
|
margin-bottom: 8px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.fb-form-inline {
|
||||||
|
display: inline-block;
|
||||||
|
margin-right: 14px;
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
|
||||||
|
.fb-form-installments {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
.fb-form-installments .fb-form-num {
|
||||||
|
width: 5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.fb-form-installments span {
|
||||||
|
margin: 0 8px;
|
||||||
|
}
|
||||||
59
Asset/js/relocate.js
Normal file
59
Asset/js/relocate.js
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
/*
|
||||||
|
* FinanceBuddy -- place the "Hide/Show column total" entry inside the native column menu.
|
||||||
|
*
|
||||||
|
* Kanboard only exposes the template:board:column:dropdown hook AFTER the column menu <ul>, and its
|
||||||
|
* dropdown JS clones just that <ul> when the menu opens. So the hook item cannot reach the menu on
|
||||||
|
* its own. column_dropdown.php renders the item hidden next to the menu; this script moves each such
|
||||||
|
* item into that column's real <ul> so it appears alongside "Hide this column", etc.
|
||||||
|
*
|
||||||
|
* BoardDragAndDrop.refresh() does $("#board-container").replaceWith(data) on every drag-and-drop and
|
||||||
|
* poll refresh, so the observer is bound to the STABLE parent of #board-container (which survives the
|
||||||
|
* swap), not to #board-container itself -- otherwise it would be left watching a detached node and
|
||||||
|
* the entry would vanish until a full page reload.
|
||||||
|
*/
|
||||||
|
(function () {
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
function relocate() {
|
||||||
|
var items = document.querySelectorAll(".financebuddy-menu-item");
|
||||||
|
|
||||||
|
for (var i = 0; i < items.length; i++) {
|
||||||
|
var li = items[i];
|
||||||
|
|
||||||
|
// Already moved into a menu list: just make sure it is visible.
|
||||||
|
if (li.closest("ul")) {
|
||||||
|
li.style.display = "";
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The hook renders the item as a child of the column's dropdown wrapper; its first <ul>
|
||||||
|
// is the native menu.
|
||||||
|
var menu = li.parentNode ? li.parentNode.querySelector("ul") : null;
|
||||||
|
|
||||||
|
if (menu) {
|
||||||
|
menu.appendChild(li);
|
||||||
|
li.style.display = "";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function init() {
|
||||||
|
var container = document.getElementById("board-container");
|
||||||
|
|
||||||
|
if (!container) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
relocate();
|
||||||
|
|
||||||
|
if (window.MutationObserver && container.parentNode) {
|
||||||
|
new MutationObserver(relocate).observe(container.parentNode, { childList: true, subtree: true });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (document.readyState === "loading") {
|
||||||
|
document.addEventListener("DOMContentLoaded", init);
|
||||||
|
} else {
|
||||||
|
init();
|
||||||
|
}
|
||||||
|
})();
|
||||||
0
Controller/.gitkeep
Normal file
0
Controller/.gitkeep
Normal file
34
Controller/FinanceColumnController.php
Normal file
34
Controller/FinanceColumnController.php
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Kanboard\Plugin\FinanceBuddy\Controller;
|
||||||
|
|
||||||
|
use Kanboard\Controller\BaseController;
|
||||||
|
use Kanboard\Core\Controller\AccessForbiddenException;
|
||||||
|
use Kanboard\Plugin\FinanceBuddy\Helper\FinanceHelper;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Toggle a board column's header total on/off from the column dropdown menu. The per-column flag
|
||||||
|
* lives in project metadata; project-manager gated (same scope as enabling FinanceBuddy). Returns
|
||||||
|
* to the board, whose reload re-renders the header with or without the total.
|
||||||
|
*/
|
||||||
|
class FinanceColumnController extends BaseController
|
||||||
|
{
|
||||||
|
public function toggleTotal()
|
||||||
|
{
|
||||||
|
$this->checkCSRFParam();
|
||||||
|
$project = $this->getProject();
|
||||||
|
|
||||||
|
if (! $this->helper->user->hasProjectAccess('ProjectEditController', 'edit', $project['id'])) {
|
||||||
|
throw new AccessForbiddenException();
|
||||||
|
}
|
||||||
|
|
||||||
|
$key = FinanceHelper::HIDE_TOTAL_PREFIX.$this->request->getIntegerParam('column_id');
|
||||||
|
|
||||||
|
// Store the literal 'on'/'off' (both non-empty) rather than 1/0, so the flag is never lost
|
||||||
|
// to PHP's empty("0") === true on the metadata save.
|
||||||
|
$hidden = $this->projectMetadataModel->get($project['id'], $key, FinanceHelper::HIDE_TOTAL_OFF) === FinanceHelper::HIDE_TOTAL_ON;
|
||||||
|
$this->projectMetadataModel->save($project['id'], array($key => $hidden ? FinanceHelper::HIDE_TOTAL_OFF : FinanceHelper::HIDE_TOTAL_ON));
|
||||||
|
|
||||||
|
$this->response->redirect($this->helper->url->to('BoardViewController', 'show', array('project_id' => $project['id'])));
|
||||||
|
}
|
||||||
|
}
|
||||||
189
Helper/FinanceHelper.php
Normal file
189
Helper/FinanceHelper.php
Normal file
@@ -0,0 +1,189 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Kanboard\Plugin\FinanceBuddy\Helper;
|
||||||
|
|
||||||
|
use Kanboard\Core\Base;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Template/controller helper for FinanceBuddy.
|
||||||
|
*
|
||||||
|
* FinanceBuddy is opt-in per board: every render and save point is gated on isEnabled(), so an
|
||||||
|
* un-enabled board is untouched. The enable flag lives in project metadata (financebuddy_enabled);
|
||||||
|
* the per-task money lives in task metadata under the keys below.
|
||||||
|
*/
|
||||||
|
class FinanceHelper extends Base
|
||||||
|
{
|
||||||
|
const ENABLED_KEY = 'financebuddy_enabled';
|
||||||
|
const AMOUNT_KEY = 'financebuddy_amount';
|
||||||
|
const DIRECTION_KEY = 'financebuddy_direction';
|
||||||
|
const INSTALLMENT_CURRENT_KEY = 'financebuddy_installment_current';
|
||||||
|
const INSTALLMENT_TOTAL_KEY = 'financebuddy_installment_total';
|
||||||
|
|
||||||
|
// Per-column opt-out of the header total. Stored per column in PROJECT metadata as
|
||||||
|
// financebuddy_hide_total_<column_id> = 'on' (hidden) or 'off' (shown, the default). Literal
|
||||||
|
// on/off, never 1/0, so the flag is never dropped by the metadata save (PHP empty("0") === true).
|
||||||
|
const HIDE_TOTAL_PREFIX = 'financebuddy_hide_total_';
|
||||||
|
const HIDE_TOTAL_ON = 'on';
|
||||||
|
const HIDE_TOTAL_OFF = 'off';
|
||||||
|
|
||||||
|
// Hidden marker present only when the task form was submitted with the finance fieldset, so
|
||||||
|
// non-finance task updates (moves, API calls) are ignored by the persistence hooks.
|
||||||
|
const FORM_MARKER = 'financebuddy_form';
|
||||||
|
|
||||||
|
// Memoized per project_id: the board hooks below call isEnabled() once per card.
|
||||||
|
private static $enabledCache = array();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Is FinanceBuddy enabled for this board?
|
||||||
|
*
|
||||||
|
* @param integer $project_id
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public function isEnabled($project_id)
|
||||||
|
{
|
||||||
|
$project_id = (int) $project_id;
|
||||||
|
|
||||||
|
if (! isset(self::$enabledCache[$project_id])) {
|
||||||
|
self::$enabledCache[$project_id] = (int) $this->projectMetadataModel->get($project_id, self::ENABLED_KEY, 0) === 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
return self::$enabledCache[$project_id];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Stored finance values for a task, with defaults. One query (getAll) since the board renders
|
||||||
|
* this per card.
|
||||||
|
*
|
||||||
|
* @param integer $task_id
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public function get($task_id)
|
||||||
|
{
|
||||||
|
$all = $this->taskMetadataModel->getAll($task_id);
|
||||||
|
|
||||||
|
return array(
|
||||||
|
'amount' => isset($all[self::AMOUNT_KEY]) ? $all[self::AMOUNT_KEY] : '',
|
||||||
|
'direction' => (isset($all[self::DIRECTION_KEY]) && $all[self::DIRECTION_KEY] === 'credit') ? 'credit' : 'debit',
|
||||||
|
'installment_current' => isset($all[self::INSTALLMENT_CURRENT_KEY]) ? $all[self::INSTALLMENT_CURRENT_KEY] : '',
|
||||||
|
'installment_total' => isset($all[self::INSTALLMENT_TOTAL_KEY]) ? $all[self::INSTALLMENT_TOTAL_KEY] : '',
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Net money for a board column: credits positive, debits negative, summed over the cards in
|
||||||
|
* the column. One grouped query over the column's task ids (the task rows carry no metadata).
|
||||||
|
*
|
||||||
|
* @param array $column A board column as passed to template:board:column:header ('tasks').
|
||||||
|
* @return float
|
||||||
|
*/
|
||||||
|
public function columnNet(array $column)
|
||||||
|
{
|
||||||
|
if (empty($column['tasks'])) {
|
||||||
|
return 0.0;
|
||||||
|
}
|
||||||
|
|
||||||
|
$task_ids = array();
|
||||||
|
foreach ($column['tasks'] as $task) {
|
||||||
|
$task_ids[] = (int) $task['id'];
|
||||||
|
}
|
||||||
|
|
||||||
|
$rows = $this->db->table('task_has_metadata')
|
||||||
|
->columns('task_id', 'name', 'value')
|
||||||
|
->in('task_id', $task_ids)
|
||||||
|
->in('name', array(self::AMOUNT_KEY, self::DIRECTION_KEY))
|
||||||
|
->findAll();
|
||||||
|
|
||||||
|
$amounts = array();
|
||||||
|
$directions = array();
|
||||||
|
|
||||||
|
foreach ($rows as $row) {
|
||||||
|
if ($row['name'] === self::AMOUNT_KEY) {
|
||||||
|
$amounts[$row['task_id']] = (float) $row['value'];
|
||||||
|
} else {
|
||||||
|
$directions[$row['task_id']] = $row['value'];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$net = 0.0;
|
||||||
|
foreach ($amounts as $task_id => $amount) {
|
||||||
|
if ($amount <= 0) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
$is_credit = isset($directions[$task_id]) && $directions[$task_id] === 'credit';
|
||||||
|
$net += $is_credit ? $amount : -$amount;
|
||||||
|
}
|
||||||
|
|
||||||
|
return $net;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Has this column's header total been hidden (per-column opt-out)?
|
||||||
|
*
|
||||||
|
* @param integer $project_id
|
||||||
|
* @param integer $column_id
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public function isTotalHidden($project_id, $column_id)
|
||||||
|
{
|
||||||
|
return $this->projectMetadataModel->get((int) $project_id, self::HIDE_TOTAL_PREFIX.(int) $column_id, self::HIDE_TOTAL_OFF) === self::HIDE_TOTAL_ON;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Values to prefill the task-form fields: a re-post (after a validation error) wins, then the
|
||||||
|
* stored metadata for an existing task, otherwise blanks for a new task.
|
||||||
|
*
|
||||||
|
* @param array $values
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public function formValues(array $values)
|
||||||
|
{
|
||||||
|
if (isset($values[self::FORM_MARKER])) {
|
||||||
|
return array(
|
||||||
|
'amount' => isset($values[self::AMOUNT_KEY]) ? $values[self::AMOUNT_KEY] : '',
|
||||||
|
'direction' => (isset($values[self::DIRECTION_KEY]) && $values[self::DIRECTION_KEY] === 'credit') ? 'credit' : 'debit',
|
||||||
|
'installment_current' => isset($values[self::INSTALLMENT_CURRENT_KEY]) ? $values[self::INSTALLMENT_CURRENT_KEY] : '',
|
||||||
|
'installment_total' => isset($values[self::INSTALLMENT_TOTAL_KEY]) ? $values[self::INSTALLMENT_TOTAL_KEY] : '',
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (! empty($values['id'])) {
|
||||||
|
return $this->get($values['id']);
|
||||||
|
}
|
||||||
|
|
||||||
|
return array('amount' => '', 'direction' => 'debit', 'installment_current' => '', 'installment_total' => '');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parse a user-typed amount. Accepts a dot or a comma as the decimal separator and an optional
|
||||||
|
* "R$"; there is no thousand separator. Returns a non-negative float (0.0 when unparseable).
|
||||||
|
*
|
||||||
|
* @param string $raw
|
||||||
|
* @return float
|
||||||
|
*/
|
||||||
|
public static function parseAmount($raw)
|
||||||
|
{
|
||||||
|
$raw = str_replace(array('R$', ' '), '', trim((string) $raw));
|
||||||
|
$raw = str_replace(',', '.', $raw);
|
||||||
|
|
||||||
|
if ($raw === '' || ! is_numeric($raw)) {
|
||||||
|
return 0.0;
|
||||||
|
}
|
||||||
|
|
||||||
|
$value = round((float) $raw, 2);
|
||||||
|
|
||||||
|
return $value > 0 ? $value : 0.0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Format a money value for display: two decimals, comma decimal separator, no thousand
|
||||||
|
* separator (e.g. 20.9 -> "20,90"). Accepts a float or a canonical dot-string.
|
||||||
|
*
|
||||||
|
* @param float|string $amount
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public static function money($amount)
|
||||||
|
{
|
||||||
|
return number_format((float) $amount, 2, ',', '');
|
||||||
|
}
|
||||||
|
}
|
||||||
661
LICENSE
Normal file
661
LICENSE
Normal file
@@ -0,0 +1,661 @@
|
|||||||
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 19 November 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU Affero General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works, specifically designed to ensure
|
||||||
|
cooperation with the community in the case of network server software.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
our General Public Licenses are intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
Developers that use our General Public Licenses protect your rights
|
||||||
|
with two steps: (1) assert copyright on the software, and (2) offer
|
||||||
|
you this License which gives you legal permission to copy, distribute
|
||||||
|
and/or modify the software.
|
||||||
|
|
||||||
|
A secondary benefit of defending all users' freedom is that
|
||||||
|
improvements made in alternate versions of the program, if they
|
||||||
|
receive widespread use, become available for other developers to
|
||||||
|
incorporate. Many developers of free software are heartened and
|
||||||
|
encouraged by the resulting cooperation. However, in the case of
|
||||||
|
software used on network servers, this result may fail to come about.
|
||||||
|
The GNU General Public License permits making a modified version and
|
||||||
|
letting the public access it on a server without ever releasing its
|
||||||
|
source code to the public.
|
||||||
|
|
||||||
|
The GNU Affero General Public License is designed specifically to
|
||||||
|
ensure that, in such cases, the modified source code becomes available
|
||||||
|
to the community. It requires the operator of a network server to
|
||||||
|
provide the source code of the modified version running there to the
|
||||||
|
users of that server. Therefore, public use of a modified version, on
|
||||||
|
a publicly accessible server, gives the public access to the source
|
||||||
|
code of the modified version.
|
||||||
|
|
||||||
|
An older license, called the Affero General Public License and
|
||||||
|
published by Affero, was designed to accomplish similar goals. This is
|
||||||
|
a different license, not a version of the Affero GPL, but Affero has
|
||||||
|
released a new version of the Affero GPL which permits relicensing under
|
||||||
|
this license.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, if you modify the
|
||||||
|
Program, your modified version must prominently offer all users
|
||||||
|
interacting with it remotely through a computer network (if your version
|
||||||
|
supports such interaction) an opportunity to receive the Corresponding
|
||||||
|
Source of your version by providing access to the Corresponding Source
|
||||||
|
from a network server at no charge, through some standard or customary
|
||||||
|
means of facilitating copying of software. This Corresponding Source
|
||||||
|
shall include the Corresponding Source for any work covered by version 3
|
||||||
|
of the GNU General Public License that is incorporated pursuant to the
|
||||||
|
following paragraph.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the work with which it is combined will remain governed by version
|
||||||
|
3 of the GNU General Public License.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU Affero General Public License from time to time. Such new versions
|
||||||
|
will be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU Affero General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU Affero General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU Affero General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If your software can interact with users remotely through a computer
|
||||||
|
network, you should also make sure that it provides a way for users to
|
||||||
|
get its source. For example, if your program is a web application, its
|
||||||
|
interface could display a "Source" link that leads users to an archive
|
||||||
|
of the code. There are many ways you could offer source, and different
|
||||||
|
solutions will be better for different programs; see section 13 for the
|
||||||
|
specific requirements.
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
0
Locale/.gitkeep
Normal file
0
Locale/.gitkeep
Normal file
0
Model/.gitkeep
Normal file
0
Model/.gitkeep
Normal file
226
Model/FinancePersistence.php
Normal file
226
Model/FinancePersistence.php
Normal file
@@ -0,0 +1,226 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Kanboard\Plugin\FinanceBuddy\Model;
|
||||||
|
|
||||||
|
use Kanboard\Core\Base;
|
||||||
|
use Kanboard\Plugin\FinanceBuddy\Helper\FinanceHelper;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Persists the FinanceBuddy fields that live in the core task form.
|
||||||
|
*
|
||||||
|
* PicoDb's insert()/update() build SQL straight from the value keys, so any non-column field left
|
||||||
|
* in $values would break task saving (this is why core unset()s "tags"). We therefore:
|
||||||
|
* (a) strip every financebuddy_* key from $values in the create/modify "prepare" hooks, and
|
||||||
|
* (b) write the values to task metadata separately.
|
||||||
|
*
|
||||||
|
* Everything here runs synchronously inside the model call during the HTTP request (the "prepare"
|
||||||
|
* and "aftersave" reference hooks), so it does NOT depend on the optionally-async event queue. The
|
||||||
|
* finance values are read straight from $values (getValues() cannot be reused: the controller
|
||||||
|
* already consumed the CSRF token). The task id comes from the aftersave hook (create) or the
|
||||||
|
* route parameter (modify).
|
||||||
|
*/
|
||||||
|
class FinancePersistence extends Base
|
||||||
|
{
|
||||||
|
private $pending = null;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* model:task:creation:prepare -- fires before INSERT, $values by reference, no task id yet.
|
||||||
|
*/
|
||||||
|
public function onCreationPrepare(array &$values)
|
||||||
|
{
|
||||||
|
$this->pending = null;
|
||||||
|
|
||||||
|
if (isset($values[FinanceHelper::FORM_MARKER])) {
|
||||||
|
$this->pending = array(
|
||||||
|
'project_id' => isset($values['project_id']) ? (int) $values['project_id'] : 0,
|
||||||
|
'fields' => $this->extract($values),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->strip($values);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* model:task:creation:aftersave -- fires after INSERT, hands over the new task id by reference.
|
||||||
|
*/
|
||||||
|
public function onCreationAfterSave(&$task_id)
|
||||||
|
{
|
||||||
|
if ($this->pending !== null) {
|
||||||
|
$this->persist((int) $task_id, $this->pending['project_id'], $this->pending['fields']);
|
||||||
|
$this->pending = null;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Not a form submission. Native recurrence builds the next occurrence with a plain task
|
||||||
|
// create (which copies no metadata) after setting recurrence_parent to the source task, so
|
||||||
|
// carry the finance metadata across -- otherwise the recurring card loses its money.
|
||||||
|
$task = $this->taskFinderModel->getById((int) $task_id);
|
||||||
|
|
||||||
|
if (! empty($task['recurrence_parent'])) {
|
||||||
|
// A recurrence is the NEXT occurrence, so advance the installment (p2/30 -> p3/30).
|
||||||
|
$this->copyMetadata((int) $task['recurrence_parent'], (int) $task_id, true);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* model:task:duplication:aftersave -- the manual "Duplicate" action. TaskDuplicationModel does
|
||||||
|
* not copy metadata, so carry the finance fields to the new task.
|
||||||
|
*/
|
||||||
|
public function onDuplication(array &$hook_values)
|
||||||
|
{
|
||||||
|
if (! empty($hook_values['source_task_id']) && ! empty($hook_values['destination_task_id'])) {
|
||||||
|
$this->copyMetadata((int) $hook_values['source_task_id'], (int) $hook_values['destination_task_id']);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* recoreco:task:spawned -- RecoReco (calendar recurrence) just spawned a copy. Its ongoing card
|
||||||
|
* is the TEMPLATE that stays (unlike native recurrence, whose ongoing card is the new child), so
|
||||||
|
* advance the SOURCE template's installment. The clone already copied the current installment
|
||||||
|
* verbatim via onDuplication during RecoReco's duplicate() call.
|
||||||
|
*/
|
||||||
|
public function onRecoRecoSpawn(array &$payload)
|
||||||
|
{
|
||||||
|
if (! empty($payload['source_task_id'])) {
|
||||||
|
$this->advanceInstallment((int) $payload['source_task_id']);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* model:task:modification:prepare -- fires before UPDATE, $values by reference. The task id is
|
||||||
|
* removed from $values by core, but it is the route parameter of the modification request.
|
||||||
|
*/
|
||||||
|
public function onModificationPrepare(array &$values)
|
||||||
|
{
|
||||||
|
if (isset($values[FinanceHelper::FORM_MARKER])) {
|
||||||
|
$task_id = $this->request->getIntegerParam('task_id');
|
||||||
|
$project_id = isset($values['project_id']) ? (int) $values['project_id'] : 0;
|
||||||
|
|
||||||
|
if ($task_id > 0) {
|
||||||
|
$this->persist($task_id, $project_id, $this->extract($values));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->strip($values);
|
||||||
|
}
|
||||||
|
|
||||||
|
private function extract(array $values)
|
||||||
|
{
|
||||||
|
return array(
|
||||||
|
'amount' => isset($values[FinanceHelper::AMOUNT_KEY]) ? $values[FinanceHelper::AMOUNT_KEY] : '',
|
||||||
|
'direction' => (isset($values[FinanceHelper::DIRECTION_KEY]) && $values[FinanceHelper::DIRECTION_KEY] === 'credit') ? 'credit' : 'debit',
|
||||||
|
'installment_current' => isset($values[FinanceHelper::INSTALLMENT_CURRENT_KEY]) ? $values[FinanceHelper::INSTALLMENT_CURRENT_KEY] : '',
|
||||||
|
'installment_total' => isset($values[FinanceHelper::INSTALLMENT_TOTAL_KEY]) ? $values[FinanceHelper::INSTALLMENT_TOTAL_KEY] : '',
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
private function strip(array &$values)
|
||||||
|
{
|
||||||
|
foreach (array_keys($values) as $key) {
|
||||||
|
if (strpos($key, 'financebuddy_') === 0) {
|
||||||
|
unset($values[$key]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private function persist($task_id, $project_id, array $fields)
|
||||||
|
{
|
||||||
|
// Only touch metadata on boards where a manager opted in.
|
||||||
|
if ((int) $this->projectMetadataModel->get($project_id, FinanceHelper::ENABLED_KEY, 0) !== 1) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$amount = FinanceHelper::parseAmount($fields['amount']);
|
||||||
|
|
||||||
|
// No (or cleared) amount: drop any finance metadata so the card goes back to plain.
|
||||||
|
if ($amount <= 0) {
|
||||||
|
foreach (array(FinanceHelper::AMOUNT_KEY, FinanceHelper::DIRECTION_KEY, FinanceHelper::INSTALLMENT_CURRENT_KEY, FinanceHelper::INSTALLMENT_TOTAL_KEY) as $key) {
|
||||||
|
$this->taskMetadataModel->remove($task_id, $key);
|
||||||
|
}
|
||||||
|
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->taskMetadataModel->save($task_id, array(
|
||||||
|
FinanceHelper::AMOUNT_KEY => number_format($amount, 2, '.', ''),
|
||||||
|
FinanceHelper::DIRECTION_KEY => $fields['direction'] === 'credit' ? 'credit' : 'debit',
|
||||||
|
FinanceHelper::INSTALLMENT_CURRENT_KEY => $this->intOrBlank($fields['installment_current']),
|
||||||
|
FinanceHelper::INSTALLMENT_TOTAL_KEY => $this->intOrBlank($fields['installment_total']),
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Copy the finance metadata from one task to another (recurrence next occurrence, or a manual
|
||||||
|
* duplicate). When $advance is true, bump the current installment by one -- clamped at the
|
||||||
|
* total so a finite plan stops at its last installment (e.g. p30/30 stays p30/30).
|
||||||
|
*/
|
||||||
|
private function copyMetadata($source_id, $dest_id, $advance = false)
|
||||||
|
{
|
||||||
|
if ($source_id <= 0 || $dest_id <= 0) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$amount = $this->taskMetadataModel->get($source_id, FinanceHelper::AMOUNT_KEY, '');
|
||||||
|
|
||||||
|
// Nothing to carry over if the source has no money set.
|
||||||
|
if ($amount === '' || (float) $amount <= 0) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$direction = $this->taskMetadataModel->get($source_id, FinanceHelper::DIRECTION_KEY, 'debit');
|
||||||
|
$current = $this->taskMetadataModel->get($source_id, FinanceHelper::INSTALLMENT_CURRENT_KEY, '');
|
||||||
|
$total = $this->taskMetadataModel->get($source_id, FinanceHelper::INSTALLMENT_TOTAL_KEY, '');
|
||||||
|
|
||||||
|
if ($advance && $current !== '' && ctype_digit((string) $current)) {
|
||||||
|
$next = (int) $current + 1;
|
||||||
|
|
||||||
|
if ($total !== '' && ctype_digit((string) $total) && $next > (int) $total) {
|
||||||
|
$next = (int) $total;
|
||||||
|
}
|
||||||
|
|
||||||
|
$current = (string) $next;
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->taskMetadataModel->save($dest_id, array(
|
||||||
|
FinanceHelper::AMOUNT_KEY => $amount,
|
||||||
|
FinanceHelper::DIRECTION_KEY => $direction === 'credit' ? 'credit' : 'debit',
|
||||||
|
FinanceHelper::INSTALLMENT_CURRENT_KEY => $current,
|
||||||
|
FinanceHelper::INSTALLMENT_TOTAL_KEY => $total,
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Advance a task's current installment by one, in place. A finite plan clamps at total+1, one
|
||||||
|
* past the last installment: that overflow is the "plan complete" tombstone (p4/3) that RecoReco
|
||||||
|
* reads to stop a following recurrence, and it caps runaway when nothing follows. Clones still
|
||||||
|
* read p1/total .. pTotal/total because a clone snapshots current BEFORE this advance. An
|
||||||
|
* open-ended plan (no total) increments unbounded (p2 -> p3); cards with no numeric current
|
||||||
|
* installment are left alone.
|
||||||
|
*/
|
||||||
|
private function advanceInstallment($task_id)
|
||||||
|
{
|
||||||
|
$current = $this->taskMetadataModel->get($task_id, FinanceHelper::INSTALLMENT_CURRENT_KEY, '');
|
||||||
|
|
||||||
|
if ($current === '' || ! ctype_digit((string) $current)) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$total = $this->taskMetadataModel->get($task_id, FinanceHelper::INSTALLMENT_TOTAL_KEY, '');
|
||||||
|
$next = (int) $current + 1;
|
||||||
|
|
||||||
|
if ($total !== '' && ctype_digit((string) $total) && $next > (int) $total + 1) {
|
||||||
|
$next = (int) $total + 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->taskMetadataModel->save($task_id, array(
|
||||||
|
FinanceHelper::INSTALLMENT_CURRENT_KEY => (string) $next,
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
private function intOrBlank($raw)
|
||||||
|
{
|
||||||
|
$raw = trim((string) $raw);
|
||||||
|
|
||||||
|
return ($raw !== '' && ctype_digit($raw) && (int) $raw > 0) ? (string) (int) $raw : '';
|
||||||
|
}
|
||||||
|
}
|
||||||
100
Plugin.php
Normal file
100
Plugin.php
Normal file
@@ -0,0 +1,100 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Kanboard\Plugin\FinanceBuddy;
|
||||||
|
|
||||||
|
use Kanboard\Core\Plugin\Base;
|
||||||
|
|
||||||
|
class Plugin extends Base
|
||||||
|
{
|
||||||
|
public function initialize()
|
||||||
|
{
|
||||||
|
// Plugin stylesheet. Empty for now; the money badge and per-column total styling
|
||||||
|
// are added as those features land in later versions.
|
||||||
|
$this->hook->on('template:layout:css', array(
|
||||||
|
'template' => 'plugins/FinanceBuddy/Asset/css/finance.css',
|
||||||
|
));
|
||||||
|
|
||||||
|
// Per-board opt-in: a checkbox on the project's Settings -> Integrations page. Nothing
|
||||||
|
// else in the plugin renders or saves until a project manager enables it for that board.
|
||||||
|
$this->template->hook->attach('template:project:integrations', 'financeBuddy:project/integration');
|
||||||
|
|
||||||
|
// Finance fields in the task create/edit form (middle column). The template gates itself
|
||||||
|
// on the board being enabled. These are not task columns, so core cannot persist them:
|
||||||
|
// FinancePersistence strips them from the task write and stores them in task metadata,
|
||||||
|
// all synchronously via the model hooks below.
|
||||||
|
$this->template->hook->attach('template:task:form:second-column', 'financeBuddy:task/form_fields');
|
||||||
|
|
||||||
|
$persistence = new \Kanboard\Plugin\FinanceBuddy\Model\FinancePersistence($this->container);
|
||||||
|
$this->hook->on('model:task:creation:prepare', array($persistence, 'onCreationPrepare'));
|
||||||
|
$this->hook->on('model:task:creation:aftersave', array($persistence, 'onCreationAfterSave'));
|
||||||
|
$this->hook->on('model:task:modification:prepare', array($persistence, 'onModificationPrepare'));
|
||||||
|
|
||||||
|
// Carry the finance metadata onto copies (which Kanboard does not copy): native recurrence
|
||||||
|
// advances the installment for the next occurrence (creation:aftersave via recurrence_parent),
|
||||||
|
// and a manual Duplicate copies it verbatim.
|
||||||
|
$this->hook->on('model:task:duplication:aftersave', array($persistence, 'onDuplication'));
|
||||||
|
|
||||||
|
// RecoReco (calendar recurrence) spawns a copy and emits this signal. The clone already got
|
||||||
|
// the finance verbatim (via onDuplication above); here we advance the SOURCE template's
|
||||||
|
// installment, since RecoReco's ongoing card is the template that stays.
|
||||||
|
$this->hook->on('recoreco:task:spawned', array($persistence, 'onRecoRecoSpawn'));
|
||||||
|
|
||||||
|
// The line-3 money badge on each board card, rendered directly under the title. Two hooks:
|
||||||
|
// "private" is the normal board, "public" is the read-only board shared by token.
|
||||||
|
$this->template->hook->attach('template:board:private:task:after-title', 'financeBuddy:board/task_money');
|
||||||
|
$this->template->hook->attach('template:board:public:task:after-title', 'financeBuddy:board/task_money');
|
||||||
|
|
||||||
|
// Per-column net total (credits - debits) in the column header.
|
||||||
|
$this->template->hook->attach('template:board:column:header', 'financeBuddy:board/column_total');
|
||||||
|
|
||||||
|
// "Hide/Show column total" toggle in the column dropdown menu. The only column-menu hook
|
||||||
|
// renders after the native <ul>, so column_dropdown.php emits the item hidden and relocate.js
|
||||||
|
// moves it into the menu (same technique as BulkMoveTasks, with the stable-parent observer).
|
||||||
|
$this->template->hook->attach('template:board:column:dropdown', 'financeBuddy:board/column_dropdown');
|
||||||
|
$this->hook->on('template:layout:js', array(
|
||||||
|
'template' => 'plugins/FinanceBuddy/Asset/js/relocate.js',
|
||||||
|
));
|
||||||
|
|
||||||
|
// The same money badge at the top of the opened card (task view), under the title, so a
|
||||||
|
// card shows its money whether you are on the board or reading the card. Reuses the board
|
||||||
|
// badge template (both hooks pass $task).
|
||||||
|
$this->template->hook->attach('template:task:details:top', 'financeBuddy:board/task_money');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function getHelpers()
|
||||||
|
{
|
||||||
|
return array(
|
||||||
|
'Plugin\FinanceBuddy\Helper' => array('FinanceHelper'),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function getPluginName()
|
||||||
|
{
|
||||||
|
return 'FinanceBuddy';
|
||||||
|
}
|
||||||
|
|
||||||
|
public function getPluginDescription()
|
||||||
|
{
|
||||||
|
return t('Attach a money value (debit/credit and installments) to board cards, shown on the card and totalled per column. Opt-in per board.');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function getPluginAuthor()
|
||||||
|
{
|
||||||
|
return 'Ruben (drbeco)';
|
||||||
|
}
|
||||||
|
|
||||||
|
public function getPluginVersion()
|
||||||
|
{
|
||||||
|
return '1.2.2';
|
||||||
|
}
|
||||||
|
|
||||||
|
public function getPluginHomepage()
|
||||||
|
{
|
||||||
|
return 'https://code.beco.cc/beco/FinanceBuddy';
|
||||||
|
}
|
||||||
|
|
||||||
|
public function getCompatibleVersion()
|
||||||
|
{
|
||||||
|
return '>=1.2.0';
|
||||||
|
}
|
||||||
|
}
|
||||||
113
README.md
Normal file
113
README.md
Normal file
@@ -0,0 +1,113 @@
|
|||||||
|
# FinanceBuddy -- money on your Kanboard cards
|
||||||
|
|
||||||
|
Attach a money value to each board card, see it on the card, and total it per column, so a
|
||||||
|
Kanboard project can double as a simple, visual finance board -- bills, installments, income
|
||||||
|
vs expenses.
|
||||||
|
|
||||||
|
FinanceBuddy is **opt-in per board**: installing it changes nothing until a project manager
|
||||||
|
enables it for a specific board under Settings -> Integrations. Boards that are not enabled
|
||||||
|
look exactly as before.
|
||||||
|
|
||||||
|
## The idea: a bill-lifecycle board
|
||||||
|
|
||||||
|
Kanboard imposes no structure, so FinanceBuddy fits one rather than dictating it. A layout that
|
||||||
|
works well:
|
||||||
|
|
||||||
|
- **Columns = a bill's status:** `Templates -> Due this month -> Paid`. Cards flow left to right
|
||||||
|
as they are paid.
|
||||||
|
- **Tags = category:** housing, utilities, comms, food...
|
||||||
|
- **Due date = the bill's due date;** color/priority = urgency.
|
||||||
|
- Each card carries a **money value** and, optionally, an **installment** count.
|
||||||
|
|
||||||
|
Recurring monthly bills can live as template cards spawned each month by the companion RecoReco
|
||||||
|
plugin; FinanceBuddy only owns the money.
|
||||||
|
|
||||||
|
## What it does
|
||||||
|
|
||||||
|
Once a board is enabled:
|
||||||
|
|
||||||
|
### Set the money on a card
|
||||||
|
|
||||||
|
The task edit/create form gains a **Finance** section in the middle column:
|
||||||
|
|
||||||
|
- **Amount** in R$.
|
||||||
|
- **Debit** or **Credit** (money out vs money in).
|
||||||
|
- **Installment** current / total (for example `2` of `10`). Leave the total blank for an
|
||||||
|
open-ended recurring bill.
|
||||||
|
|
||||||
|
### See it on the card
|
||||||
|
|
||||||
|
A badge appears just under the card title -- both on the board and at the top of the opened
|
||||||
|
card, so the money is visible whether you glance at the board or read the card (no need to open
|
||||||
|
the edit form):
|
||||||
|
|
||||||
|
- **red** with a `-` for a debit, **green** with a `+` for a credit (both the color and the sign
|
||||||
|
carry the meaning, and the badge's own background stays readable on any card color);
|
||||||
|
- followed by `pN/M` when a total is set (for example `p2/10`), hidden for open-ended bills.
|
||||||
|
|
||||||
|
### Total per column
|
||||||
|
|
||||||
|
Each column header shows a **`Total:`** of its cards -- credits positive, debits negative (the
|
||||||
|
net): red when negative (what you owe), green when positive, gray at zero. It is shown for every
|
||||||
|
column, including `Total: R$0,00`.
|
||||||
|
|
||||||
|
You can hide the total on a per-column basis: open the column's dropdown menu (the caret next to
|
||||||
|
the column title) and pick **"Hide column total"**; the same menu then offers **"Show column
|
||||||
|
total"** to bring it back. This is a per-board manager action, remembered per column.
|
||||||
|
|
||||||
|
### Installments and recurrence
|
||||||
|
|
||||||
|
FinanceBuddy carries the money across copies. Kanboard's built-in recurrence and RecoReco's
|
||||||
|
calendar recurrence advance the installment on the next occurrence (`p2/10 -> p3/10`); a manual
|
||||||
|
duplicate copies it as-is. When a RecoReco-followed plan finishes, the parked template is left one
|
||||||
|
past the last installment (`p3/3 -> p4/3`) as a "plan complete" marker that RecoReco reads to stop
|
||||||
|
recurring; the copies themselves still read `p1/3 .. p3/3`. Open-ended plans (blank total) keep
|
||||||
|
counting.
|
||||||
|
|
||||||
|
## Money format
|
||||||
|
|
||||||
|
Amounts show in R$ with a comma decimal and no thousand separator (for example `R$1234,56`).
|
||||||
|
Input accepts either a dot or a comma as the decimal separator, so `1234.56` and `1234,56` are
|
||||||
|
the same value.
|
||||||
|
|
||||||
|
## How it stores data
|
||||||
|
|
||||||
|
No database migration. The per-board enable flag is stored in project metadata; each card's
|
||||||
|
money is stored in task metadata. The finance fields live in the normal task form but are saved
|
||||||
|
separately (they are not task columns), so ordinary task saving is untouched. Uninstalling the
|
||||||
|
plugin leaves that metadata harmlessly in place and changes nothing else.
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
- Kanboard >= 1.2.0
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
Copy this folder into your Kanboard installation as `plugins/FinanceBuddy/`. The directory name
|
||||||
|
must be exactly `FinanceBuddy` (Kanboard derives the plugin namespace from the folder name). No
|
||||||
|
build step and no database migration. Then, on each board you want to track, go to
|
||||||
|
Settings -> Integrations and tick "Enable FinanceBuddy on this board".
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
AGPL-3.0. See LICENSE.
|
||||||
|
|
||||||
|
## More Kanboard plugins by Dr. Beco
|
||||||
|
|
||||||
|
All free and AGPL-3.0, at [code.beco.cc](https://code.beco.cc/beco):
|
||||||
|
|
||||||
|
- **[RecoReco](https://code.beco.cc/beco/RecoReco)** -- calendar-scheduled recurring cards (yearly,
|
||||||
|
monthly, weekly, daily), driven by the card due date.
|
||||||
|
- **[QualKard](https://code.beco.cc/beco/QualKard)** -- flashcard spaced repetition: grade a card by
|
||||||
|
dragging it to a column, and it comes back when due (needs RecoReco).
|
||||||
|
- **[WorkspaceOrg](https://code.beco.cc/beco/WorkspaceOrg)** -- group your projects into personal
|
||||||
|
per-user workspaces, shown on a "My workspaces" dashboard page with a badge on each project.
|
||||||
|
- **[OrganonTweaks](https://code.beco.cc/beco/OrganonTweaks)** -- an umbrella of small
|
||||||
|
quality-of-life board tweaks: remove an empty column, always show the comment icon, emphasize due
|
||||||
|
dates, extra search keywords and shared board filters, and more.
|
||||||
|
- **[BulkMoveTasks](https://code.beco.cc/beco/BulkMoveTasks)** -- move every task from one board
|
||||||
|
column to another in a single action.
|
||||||
|
- **[ShrinkVertically](https://code.beco.cc/beco/ShrinkVertically)** -- shrink vertically-collapsed
|
||||||
|
board columns so the horizontal scrollbar stays within reach.
|
||||||
|
- **[TweakDrag](https://code.beco.cc/beco/TweakDrag)** -- board drag and touch niceties:
|
||||||
|
drag-to-scroll, a wider column gap, and smoother card dragging.
|
||||||
0
Schema/.gitkeep
Normal file
0
Schema/.gitkeep
Normal file
17
Template/board/column_dropdown.php
Normal file
17
Template/board/column_dropdown.php
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
<?php if ($this->FinanceHelper->isEnabled($column['project_id']) && $this->user->hasProjectAccess('ProjectEditController', 'edit', $column['project_id'])): ?>
|
||||||
|
<?php /* Rendered here (outside the menu <ul>) by the only column-menu hook, then moved into the
|
||||||
|
column's real dropdown <ul> by Asset/js/relocate.js so it sits next to the native
|
||||||
|
entries. Hidden until relocated to avoid a flash in the header. */ ?>
|
||||||
|
<?php $hidden = $this->FinanceHelper->isTotalHidden($column['project_id'], $column['id']); ?>
|
||||||
|
<li class="financebuddy-menu-item" style="display: none;">
|
||||||
|
<?= $this->url->link(
|
||||||
|
$hidden
|
||||||
|
? '<i class="fa fa-eye fa-fw"></i> '.t('Show column total')
|
||||||
|
: '<i class="fa fa-eye-slash fa-fw"></i> '.t('Hide column total'),
|
||||||
|
'FinanceColumnController',
|
||||||
|
'toggleTotal',
|
||||||
|
array('plugin' => 'FinanceBuddy', 'project_id' => $column['project_id'], 'column_id' => $column['id']),
|
||||||
|
true
|
||||||
|
) ?>
|
||||||
|
</li>
|
||||||
|
<?php endif ?>
|
||||||
30
Template/board/column_total.php
Normal file
30
Template/board/column_total.php
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
<?php
|
||||||
|
// Per-column net total in the column header (credits - debits). Shown in every column of an
|
||||||
|
// enabled board, including "Total: R$0,00" -- never hidden on zero. Server-side, re-renders on
|
||||||
|
// every board refresh. Rendered on its own full-width line under the title; "Total:" stays the
|
||||||
|
// default (black) and only the amount is colored by sign.
|
||||||
|
if (empty($column['project_id']) || ! $this->FinanceHelper->isEnabled($column['project_id'])) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Per-column opt-out, toggled from the column dropdown menu.
|
||||||
|
if ($this->FinanceHelper->isTotalHidden($column['project_id'], $column['id'])) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$net = $this->FinanceHelper->columnNet($column);
|
||||||
|
|
||||||
|
if ($net > 0) {
|
||||||
|
$amount_class = 'fb-total-credit';
|
||||||
|
$sign = '+';
|
||||||
|
} elseif ($net < 0) {
|
||||||
|
$amount_class = 'fb-total-debit';
|
||||||
|
$sign = '-';
|
||||||
|
} else {
|
||||||
|
$amount_class = 'fb-total-zero';
|
||||||
|
$sign = '';
|
||||||
|
}
|
||||||
|
?>
|
||||||
|
<div class="fb-column-total">
|
||||||
|
<span class="fb-total-pill"><?= t('Total') ?>: <span class="fb-amount <?= $amount_class ?>"><?= $sign ?>R$<?= \Kanboard\Plugin\FinanceBuddy\Helper\FinanceHelper::money(abs($net)) ?></span></span>
|
||||||
|
</div>
|
||||||
32
Template/board/task_money.php
Normal file
32
Template/board/task_money.php
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
<?php
|
||||||
|
// Line-3 money badge, rendered under the card title via the after-title hooks. Server-side, so
|
||||||
|
// it re-renders correctly on every board refresh. Nothing shows unless the board is enabled and
|
||||||
|
// the card has a positive amount.
|
||||||
|
if (empty($task['project_id']) || ! $this->FinanceHelper->isEnabled($task['project_id'])) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$fb = $this->FinanceHelper->get($task['id']);
|
||||||
|
|
||||||
|
if ($fb['amount'] === '' || (float) $fb['amount'] <= 0) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$credit = $fb['direction'] === 'credit';
|
||||||
|
$sign = $credit ? '+' : '-';
|
||||||
|
$total = $fb['installment_total'];
|
||||||
|
$current = $fb['installment_current'];
|
||||||
|
|
||||||
|
// Installments: "p2/10" when a total is set; "p2" (open-ended) when only the current is set;
|
||||||
|
// nothing when neither is set. Default the current to 1 if only a total was entered.
|
||||||
|
$show_installments = $current !== '' || $total !== '';
|
||||||
|
$current_display = $current !== '' ? $current : '1';
|
||||||
|
?>
|
||||||
|
<div class="fb-line">
|
||||||
|
<span class="fb-badge <?= $credit ? 'fb-badge-credit' : 'fb-badge-debit' ?>">
|
||||||
|
<?= $sign ?>R$<?= \Kanboard\Plugin\FinanceBuddy\Helper\FinanceHelper::money($fb['amount']) ?>
|
||||||
|
</span>
|
||||||
|
<?php if ($show_installments): ?>
|
||||||
|
<span class="fb-installments">p<?= $this->text->e($current_display) ?><?= $total !== '' ? '/'.$this->text->e($total) : '' ?></span>
|
||||||
|
<?php endif ?>
|
||||||
|
</div>
|
||||||
21
Template/project/integration.php
Normal file
21
Template/project/integration.php
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
<h3><i class="fa fa-money fa-fw" aria-hidden="true"></i> <?= t('FinanceBuddy') ?></h3>
|
||||||
|
<div class="listing">
|
||||||
|
<?php /* Hidden 0 before the checkbox so unchecking posts a value (a bare unchecked box posts
|
||||||
|
nothing, which would leave a stale 1). The checkbox's 1 wins when checked. The shared
|
||||||
|
Integrations form saves this straight into project metadata. */ ?>
|
||||||
|
<input type="hidden" name="<?= \Kanboard\Plugin\FinanceBuddy\Helper\FinanceHelper::ENABLED_KEY ?>" value="0">
|
||||||
|
<?= $this->form->checkbox(
|
||||||
|
\Kanboard\Plugin\FinanceBuddy\Helper\FinanceHelper::ENABLED_KEY,
|
||||||
|
t('Enable FinanceBuddy on this board'),
|
||||||
|
1,
|
||||||
|
isset($values['financebuddy_enabled']) && $values['financebuddy_enabled'] == 1
|
||||||
|
) ?>
|
||||||
|
<p class="form-help">
|
||||||
|
<?= t('When enabled, cards on this board can carry a money value (debit or credit, with optional installments), shown on the card and totalled per column. Boards left disabled are unaffected.') ?>
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="form-actions">
|
||||||
|
<button type="submit" class="btn btn-blue"><?= t('Save') ?></button>
|
||||||
|
</div>
|
||||||
|
<hr>
|
||||||
29
Template/task/form_fields.php
Normal file
29
Template/task/form_fields.php
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
<?php if (empty($values['project_id']) || ! $this->FinanceHelper->isEnabled($values['project_id'])): ?>
|
||||||
|
<?php else: ?>
|
||||||
|
<?php $fb = $this->FinanceHelper->formValues($values) ?>
|
||||||
|
|
||||||
|
<div class="fb-form">
|
||||||
|
<input type="hidden" name="<?= \Kanboard\Plugin\FinanceBuddy\Helper\FinanceHelper::FORM_MARKER ?>" value="1">
|
||||||
|
|
||||||
|
<label for="financebuddy_amount"><?= t('Amount (R$)') ?></label>
|
||||||
|
<input type="text" id="financebuddy_amount" name="financebuddy_amount" value="<?= $this->text->e($fb['amount']) ?>" placeholder="0,00" autocomplete="off">
|
||||||
|
|
||||||
|
<label><?= t('Type') ?></label>
|
||||||
|
<div class="fb-form-directions">
|
||||||
|
<label class="fb-form-inline">
|
||||||
|
<input type="radio" name="financebuddy_direction" value="debit" <?= $fb['direction'] !== 'credit' ? 'checked="checked"' : '' ?>> <?= t('Debit') ?>
|
||||||
|
</label>
|
||||||
|
<label class="fb-form-inline">
|
||||||
|
<input type="radio" name="financebuddy_direction" value="credit" <?= $fb['direction'] === 'credit' ? 'checked="checked"' : '' ?>> <?= t('Credit') ?>
|
||||||
|
</label>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<label for="financebuddy_installment_current"><?= t('Installment') ?></label>
|
||||||
|
<div class="fb-form-installments">
|
||||||
|
<input type="number" min="1" id="financebuddy_installment_current" name="financebuddy_installment_current" value="<?= $this->text->e($fb['installment_current']) ?>" class="fb-form-num">
|
||||||
|
<span><?= t('of') ?></span>
|
||||||
|
<input type="number" min="1" name="financebuddy_installment_total" value="<?= $this->text->e($fb['installment_total']) ?>" class="fb-form-num">
|
||||||
|
</div>
|
||||||
|
<p class="form-help"><?= t('Set a total for a finite plan (shows p2/10); leave it blank for an open-ended count (shows p2).') ?></p>
|
||||||
|
</div>
|
||||||
|
<?php endif ?>
|
||||||
0
Test/.gitkeep
Normal file
0
Test/.gitkeep
Normal file
Reference in New Issue
Block a user