xref: /webtrees/app/Module/FamilyTreeNewsModule.php (revision e54621ab8df593cd21c870a22c735c6b8421339d)
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2019 webtrees development team
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16declare(strict_types=1);
17
18namespace Fisharebest\Webtrees\Module;
19
20use Fisharebest\Webtrees\Auth;
21use Fisharebest\Webtrees\Database;
22use Fisharebest\Webtrees\I18N;
23use Fisharebest\Webtrees\Tree;
24use Symfony\Component\HttpFoundation\RedirectResponse;
25use Symfony\Component\HttpFoundation\Request;
26use Symfony\Component\HttpFoundation\Response;
27use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
28
29/**
30 * Class FamilyTreeNewsModule
31 */
32class FamilyTreeNewsModule extends AbstractModule implements ModuleBlockInterface
33{
34    /**
35     * How should this module be labelled on tabs, menus, etc.?
36     *
37     * @return string
38     */
39    public function getTitle(): string
40    {
41        /* I18N: Name of a module */
42        return I18N::translate('News');
43    }
44
45    /**
46     * A sentence describing what this module does.
47     *
48     * @return string
49     */
50    public function getDescription(): string
51    {
52        /* I18N: Description of the “News” module */
53        return I18N::translate('Family news and site announcements.');
54    }
55
56    /**
57     * Generate the HTML content of this block.
58     *
59     * @param Tree     $tree
60     * @param int      $block_id
61     * @param string   $ctype
62     * @param string[] $cfg
63     *
64     * @return string
65     */
66    public function getBlock(Tree $tree, int $block_id, string $ctype = '', array $cfg = []): string
67    {
68        $articles = Database::prepare(
69            "SELECT news_id, user_id, gedcom_id, UNIX_TIMESTAMP(updated) AS updated, subject, body FROM `##news` WHERE gedcom_id = :tree_id ORDER BY updated DESC"
70        )->execute([
71            'tree_id' => $tree->id(),
72        ])->fetchAll();
73
74        $content = view('modules/gedcom_news/list', [
75            'articles' => $articles,
76            'block_id' => $block_id,
77            'limit'    => 5,
78        ]);
79
80        if ($ctype !== '') {
81            return view('modules/block-template', [
82                'block'      => str_replace('_', '-', $this->getName()),
83                'id'         => $block_id,
84                'config_url' => '',
85                'title'      => $this->getTitle(),
86                'content'    => $content,
87            ]);
88        }
89
90        return $content;
91    }
92
93    /** {@inheritdoc} */
94    public function loadAjax(): bool
95    {
96        return false;
97    }
98
99    /** {@inheritdoc} */
100    public function isUserBlock(): bool
101    {
102        return false;
103    }
104
105    /** {@inheritdoc} */
106    public function isGedcomBlock(): bool
107    {
108        return true;
109    }
110
111    /**
112     * Update the configuration for a block.
113     *
114     * @param Request $request
115     * @param int     $block_id
116     *
117     * @return void
118     */
119    public function saveBlockConfiguration(Request $request, int $block_id)
120    {
121    }
122
123    /**
124     * An HTML form to edit block settings
125     *
126     * @param Tree $tree
127     * @param int  $block_id
128     *
129     * @return void
130     */
131    public function editBlockConfiguration(Tree $tree, int $block_id)
132    {
133    }
134
135    /**
136     * @param Request $request
137     * @param Tree    $tree
138     *
139     * @return Response
140     */
141    public function getEditNewsAction(Request $request, Tree $tree): Response
142    {
143        if (!Auth::isManager($tree)) {
144            throw new AccessDeniedHttpException();
145        }
146
147        $news_id = $request->get('news_id');
148
149        if ($news_id > 0) {
150            $row = Database::prepare(
151                "SELECT subject, body FROM `##news` WHERE news_id = :news_id AND gedcom_id = :tree_id"
152            )->execute([
153                'news_id' => $news_id,
154                'tree_id' => $tree->id(),
155            ])->fetchOneRow();
156        } else {
157            $row = (object) [
158                'body'    => '',
159                'subject' => '',
160            ];
161        }
162
163        $title = I18N::translate('Add/edit a journal/news entry');
164
165        return $this->viewResponse('modules/gedcom_news/edit', [
166            'body'    => $row->body,
167            'news_id' => $news_id,
168            'subject' => $row->subject,
169            'title'   => $title,
170        ]);
171    }
172
173    /**
174     * @param Request $request
175     * @param Tree    $tree
176     *
177     * @return RedirectResponse
178     */
179    public function postEditNewsAction(Request $request, Tree $tree): RedirectResponse
180    {
181        if (!Auth::isManager($tree)) {
182            throw new AccessDeniedHttpException();
183        }
184
185        $news_id = $request->get('news_id');
186        $subject = $request->get('subject');
187        $body    = $request->get('body');
188
189        if ($news_id > 0) {
190            Database::prepare(
191                "UPDATE `##news` SET subject = :subject, body = :body, updated = CURRENT_TIMESTAMP" .
192                " WHERE news_id = :news_id AND gedcom_id = :tree_id"
193            )->execute([
194                'subject' => $subject,
195                'body'    => $body,
196                'news_id' => $news_id,
197                'tree_id' => $tree->id(),
198            ]);
199        } else {
200            Database::prepare(
201                "INSERT INTO `##news` (gedcom_id, subject, body, updated) VALUES (:tree_id, :subject ,:body, CURRENT_TIMESTAMP)"
202            )->execute([
203                'body'    => $body,
204                'subject' => $subject,
205                'tree_id' => $tree->id(),
206            ]);
207        }
208
209        $url = route('tree-page', [
210            'ged' => $tree->name(),
211        ]);
212
213        return new RedirectResponse($url);
214    }
215
216    /**
217     * @param Request $request
218     * @param Tree    $tree
219     *
220     * @return RedirectResponse
221     */
222    public function postDeleteNewsAction(Request $request, Tree $tree): RedirectResponse
223    {
224        $news_id = $request->get('news_id');
225
226        if (!Auth::isManager($tree)) {
227            throw new AccessDeniedHttpException();
228        }
229
230        Database::prepare(
231            "DELETE FROM `##news` WHERE news_id = :news_id AND gedcom_id = :tree_id"
232        )->execute([
233            'news_id' => $news_id,
234            'tree_id' => $tree->id(),
235        ]);
236
237        $url = route('tree-page', [
238            'ged' => $tree->name(),
239        ]);
240
241        return new RedirectResponse($url);
242    }
243}
244