1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2019 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* 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 General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Family;
use Fisharebest\Webtrees\GedcomRecord;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Individual;
use Fisharebest\Webtrees\Tree;
use Illuminate\Database\Capsule\Manager as DB;
use Illuminate\Database\Query\JoinClause;
use Illuminate\Support\Collection;
use Symfony\Component\HttpFoundation\Request;
/**
* Class ResearchTaskModule
*/
class ResearchTaskModule extends AbstractModule implements ModuleInterface, ModuleBlockInterface
{
use ModuleBlockTrait;
private const DEFAULT_SHOW_OTHER = '1';
private const DEFAULT_SHOW_UNASSIGNED = '1';
private const DEFAULT_SHOW_FUTURE = '1';
/** {@inheritdoc} */
public function title(): string
{
/* I18N: Name of a module. Tasks that need further research. */
return I18N::translate('Research tasks');
}
/** {@inheritdoc} */
public function description(): string
{
/* I18N: Description of “Research tasks” module */
return I18N::translate('A list of tasks and activities that are linked to the family tree.');
}
/**
* Generate the HTML content of this block.
*
* @param Tree $tree
* @param int $block_id
* @param string $ctype
* @param string[] $cfg
*
* @return string
*/
public function getBlock(Tree $tree, int $block_id, string $ctype = '', array $cfg = []): string
{
$show_other = $this->getBlockSetting($block_id, 'show_other', self::DEFAULT_SHOW_OTHER);
$show_unassigned = $this->getBlockSetting($block_id, 'show_unassigned', self::DEFAULT_SHOW_UNASSIGNED);
$show_future = $this->getBlockSetting($block_id, 'show_future', self::DEFAULT_SHOW_FUTURE);
extract($cfg, EXTR_OVERWRITE);
$end_jd = $show_future ? 99999999 : WT_CLIENT_JD;
$individuals = $this->individualsWithTasks($tree, $end_jd);
$families = $this->familiesWithTasks($tree, $end_jd);
/** @var GedcomRecord[] $records */
$records = $individuals->merge($families);
$tasks = [];
foreach ($records as $record) {
foreach ($record->facts(['_TODO']) as $task) {
$user_name = $task->attribute('_WT_USER');
if ($user_name === Auth::user()->getUserName() || empty($user_name) && $show_unassigned || !empty($user_name) && $show_other) {
$tasks[] = $task;
}
}
}
if (empty($records)) {
$content = '<p>' . I18N::translate('There are no research tasks in this family tree.') . '</p>';
} else {
$content = view('modules/todo/research-tasks', ['tasks' => $tasks]);
}
if ($ctype !== '') {
if ($ctype === 'gedcom' && Auth::isManager($tree)) {
$config_url = route('tree-page-block-edit', [
'block_id' => $block_id,
'ged' => $tree->name(),
]);
} elseif ($ctype === 'user' && Auth::check()) {
$config_url = route('user-page-block-edit', [
'block_id' => $block_id,
'ged' => $tree->name(),
]);
} else {
$config_url = '';
}
return view('modules/block-template', [
'block' => str_replace('_', '-', $this->getName()),
'id' => $block_id,
'config_url' => $config_url,
'title' => $this->title(),
'content' => $content,
]);
}
return $content;
}
/** {@inheritdoc} */
public function loadAjax(): bool
{
return false;
}
/** {@inheritdoc} */
public function isUserBlock(): bool
{
return true;
}
/** {@inheritdoc} */
public function isGedcomBlock(): bool
{
return true;
}
/**
* Update the configuration for a block.
*
* @param Request $request
* @param int $block_id
*
* @return void
*/
public function saveBlockConfiguration(Request $request, int $block_id)
{
$this->setBlockSetting($block_id, 'show_other', $request->get('show_other', ''));
$this->setBlockSetting($block_id, 'show_unassigned', $request->get('show_unassigned', ''));
$this->setBlockSetting($block_id, 'show_future', $request->get('show_future', ''));
}
/**
* An HTML form to edit block settings
*
* @param Tree $tree
* @param int $block_id
*
* @return void
*/
public function editBlockConfiguration(Tree $tree, int $block_id)
{
$show_other = $this->getBlockSetting($block_id, 'show_other', self::DEFAULT_SHOW_OTHER);
$show_unassigned = $this->getBlockSetting($block_id, 'show_unassigned', self::DEFAULT_SHOW_UNASSIGNED);
$show_future = $this->getBlockSetting($block_id, 'show_future', self::DEFAULT_SHOW_FUTURE);
echo view('modules/todo/config', [
'show_future' => $show_future,
'show_other' => $show_other,
'show_unassigned' => $show_unassigned,
]);
}
/**
* @param Tree $tree
* @param int $max_julian_day
*
* @return Collection
*/
private function familiesWithTasks(Tree $tree, int $max_julian_day): Collection
{
return DB::table('families')
->join('dates', function (JoinClause $join): void {
$join
->on('f_file', '=', 'd_file')
->on('f_id', '=', 'd_gid');
})
->where('f_file', '=', $tree->id())
->where('d_fact', '=', '_TODO')
->where('d_julianday1', '<', $max_julian_day)
->select(['families.*'])
->distinct()
->get()
->map(Family::rowMapper())
->filter(GedcomRecord::accessFilter());
}
/**
* @param Tree $tree
* @param int $max_julian_day
*
* @return Collection
*/
private function individualsWithTasks(Tree $tree, int $max_julian_day): Collection
{
return DB::table('individuals')
->join('dates', function (JoinClause $join): void {
$join
->on('i_file', '=', 'd_file')
->on('i_id', '=', 'd_gid');
})
->where('i_file', '=', $tree->id())
->where('d_fact', '=', '_TODO')
->where('d_julianday1', '<', $max_julian_day)
->select(['individuals.*'])
->distinct()
->get()
->map(Individual::rowMapper())
->filter(GedcomRecord::accessFilter());
}
}
|
