xref: /webtrees/app/Module/FamilyTreeNewsModule.php (revision dae8440ab1203b4eb5e333de33e187c1dfc5b759)
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\I18N;
22use Fisharebest\Webtrees\Tree;
23use Illuminate\Database\Capsule\Manager as DB;
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 = DB::table('news')
69            ->where('gedcom_id', '=', $tree->id())
70            ->orderByDesc('updated')
71            ->select(['news_id', 'user_id', 'gedcom_id', DB::raw('UNIX_TIMESTAMP(updated) AS updated'), 'subject', 'body'])
72            ->get();
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 = DB::table('news')
151                ->where('news_id', '=', $news_id)
152                ->where('gedcom_id', '=', $tree->id())
153                ->first();
154        } else {
155            $row = (object) [
156                'body'    => '',
157                'subject' => '',
158            ];
159        }
160
161        $title = I18N::translate('Add/edit a journal/news entry');
162
163        return $this->viewResponse('modules/gedcom_news/edit', [
164            'body'    => $row->body,
165            'news_id' => $news_id,
166            'subject' => $row->subject,
167            'title'   => $title,
168        ]);
169    }
170
171    /**
172     * @param Request $request
173     * @param Tree    $tree
174     *
175     * @return RedirectResponse
176     */
177    public function postEditNewsAction(Request $request, Tree $tree): RedirectResponse
178    {
179        if (!Auth::isManager($tree)) {
180            throw new AccessDeniedHttpException();
181        }
182
183        $news_id = $request->get('news_id');
184        $subject = $request->get('subject');
185        $body    = $request->get('body');
186
187        if ($news_id > 0) {
188            DB::table('news')
189                ->where('news_id', '=', $news_id)
190                ->where('gedcom_id', '=', $tree->id())
191                ->update([
192                'body'    => $body,
193                'subject' => $subject,
194            ]);
195        } else {
196            DB::table('news')->insert([
197                'body'      => $body,
198                'subject'   => $subject,
199                'gedcom_id' => $tree->id(),
200            ]);
201        }
202
203        $url = route('tree-page', [
204            'ged' => $tree->name(),
205        ]);
206
207        return new RedirectResponse($url);
208    }
209
210    /**
211     * @param Request $request
212     * @param Tree    $tree
213     *
214     * @return RedirectResponse
215     */
216    public function postDeleteNewsAction(Request $request, Tree $tree): RedirectResponse
217    {
218        $news_id = $request->get('news_id');
219
220        if (!Auth::isManager($tree)) {
221            throw new AccessDeniedHttpException();
222        }
223
224        DB::table('news')
225            ->where('news_id', '=', $news_id)
226            ->where('gedcom_id', '=', $tree->id())
227            ->delete();
228
229        $url = route('tree-page', [
230            'ged' => $tree->name(),
231        ]);
232
233        return new RedirectResponse($url);
234    }
235}
236