-
Notifications
You must be signed in to change notification settings - Fork 13
Expand file tree
/
Copy pathResourcesImportController.php
More file actions
317 lines (281 loc) · 13.2 KB
/
ResourcesImportController.php
File metadata and controls
317 lines (281 loc) · 13.2 KB
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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
<?php
namespace App\Http\Controllers;
use App\Imports\ResourcesImport;
use App\Imports\ResourcesPreviewImport;
use App\Services\ResourcesImportResult;
use App\Services\ResourcesUploadValidator;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Crypt;
use Illuminate\Support\Facades\Storage;
use Illuminate\Support\Str;
use Illuminate\View\View;
use Maatwebsite\Excel\Facades\Excel;
class ResourcesImportController extends Controller
{
private const SESSION_FILE_PATH = 'resources_import_file_path';
private const SESSION_ROWS = 'resources_import_rows';
private const SESSION_FOCUS = 'resources_import_focus';
/**
* Show the resources import form (file upload + focus checkbox).
*/
public function index(): View
{
return view('admin.resources-import.index');
}
/**
* Verify file: validate, parse Excel to rows, store in session, redirect to preview.
*/
public function verify(Request $request): RedirectResponse
{
$validated = $request->validate([
'file' => [
'required',
'file',
'max:10240',
function ($attribute, $value, $fail) {
if ($value) {
$ext = strtolower($value->getClientOriginalExtension());
$allowed = ['csv', 'xlsx', 'xls'];
if (! in_array($ext, $allowed, true)) {
$filename = strtolower($value->getClientOriginalName());
if (strpos($filename, '.csv') === false && strpos($filename, '.xlsx') === false && strpos($filename, '.xls') === false) {
$fail('The file must be a CSV or Excel file (.csv, .xlsx, or .xls).');
}
}
}
},
],
'focus' => ['nullable', 'boolean'],
], [
'file.required' => 'Please select a file to upload.',
'file.max' => 'The file may not be greater than 10 MB.',
]);
$file = $request->file('file');
$extension = strtolower($file->getClientOriginalExtension() ?: '');
if (empty($extension)) {
$filename = strtolower($file->getClientOriginalName());
if (strpos($filename, '.csv') !== false) {
$extension = 'csv';
} elseif (strpos($filename, '.xlsx') !== false) {
$extension = 'xlsx';
} elseif (strpos($filename, '.xls') !== false) {
$extension = 'xls';
}
}
if (! in_array($extension, ['csv', 'xlsx', 'xls'], true)) {
return redirect()->route('admin.resources-import.index')
->withErrors(['file' => 'The file must be a CSV or Excel file (.csv, .xlsx, or .xls).'])
->withInput();
}
$tempDisk = config('filesystems.resources_import_temp_disk', 'local');
$oldPath = $request->session()->get(self::SESSION_FILE_PATH);
if ($oldPath && Storage::disk($tempDisk)->exists($oldPath)) {
Storage::disk($tempDisk)->delete($oldPath);
}
$request->session()->forget([self::SESSION_FILE_PATH, self::SESSION_ROWS, self::SESSION_FOCUS]);
$path = $file->storeAs('temp', 'resources_import_'.time().'.'.$extension, $tempDisk);
try {
$import = new ResourcesPreviewImport;
Excel::import($import, $path, $tempDisk);
$rows = $import->data;
} catch (\Throwable $e) {
Storage::disk($tempDisk)->delete($path);
return redirect()->route('admin.resources-import.index')
->withErrors(['file' => 'Could not parse file: '.$e->getMessage()])
->withInput();
}
$headerCheck = ResourcesUploadValidator::validateRequiredColumnsFromRows($rows);
if (! $headerCheck['valid']) {
Storage::disk($tempDisk)->delete($path);
return redirect()->route('admin.resources-import.index')
->withErrors(['file' => 'Missing required column(s): '.implode(', ', $headerCheck['missing']).'. Please add a header row with at least "name_of_the_resource".'])
->withInput();
}
if (empty($rows)) {
Storage::disk($tempDisk)->delete($path);
return redirect()->route('admin.resources-import.index')
->withErrors(['file' => 'The file has no data rows.'])
->withInput();
}
$focus = (bool) $request->boolean('focus');
$request->session()->put(self::SESSION_FILE_PATH, $path);
$request->session()->put(self::SESSION_ROWS, $rows);
$request->session()->put(self::SESSION_FOCUS, $focus);
$importToken = Str::random(64);
Cache::put('resources_import_' . $importToken, [
'path' => $path,
'disk' => $tempDisk,
'focus' => $focus,
], now()->addHours(1));
$request->session()->put('resources_import_token', $importToken);
return redirect()->route('admin.resources-import.preview');
}
/**
* Show preview table (editable Image URL per row). Redirect to index if no session data.
*/
public function preview(Request $request): View|RedirectResponse
{
$rows = $request->session()->get(self::SESSION_ROWS);
$focus = $request->session()->get(self::SESSION_FOCUS, false);
if (! is_array($rows) || empty($rows)) {
$request->session()->forget([self::SESSION_FILE_PATH, self::SESSION_ROWS, self::SESSION_FOCUS, 'resources_import_token']);
return redirect()->route('admin.resources-import.index')
->with('info', 'No preview data found. Please upload and verify a file first.');
}
$importToken = $request->session()->get('resources_import_token');
$path = $request->session()->get(self::SESSION_FILE_PATH);
$tempDisk = config('filesystems.resources_import_temp_disk', 'local');
$importPayload = '';
if (empty($importToken) && $path) {
$importPayload = Crypt::encryptString(json_encode([
'path' => $path,
'focus' => $focus,
'disk' => $tempDisk,
]));
}
return view('admin.resources-import.preview', [
'rows' => $rows,
'focus' => $focus,
'import_token' => $importToken ?? '',
'import_payload' => $importPayload,
]);
}
/**
* Run import with file path (from form payload or session) and request edits; redirect to report.
* Uses encrypted form payload so import works when session is not shared (e.g. load-balanced servers).
*/
public function import(Request $request): RedirectResponse
{
$path = null;
$focus = false;
$tempDisk = config('filesystems.resources_import_temp_disk', 'local');
$token = $request->input('import_token');
if (is_string($token) && $token !== '') {
$cached = Cache::get('resources_import_' . $token);
if (is_array($cached) && ! empty($cached['path'])) {
$path = $cached['path'];
$tempDisk = $cached['disk'] ?? $tempDisk;
$focus = (bool) ($cached['focus'] ?? false);
}
}
if (! $path) {
$payload = $request->input('import_payload');
if (empty($payload) || ! is_string($payload)) {
$payload = $request->session()->get('resources_import_payload');
}
if (is_string($payload) && $payload !== '') {
try {
$decoded = json_decode(Crypt::decryptString($payload), true);
if (is_array($decoded) && ! empty($decoded['path'])) {
$path = $decoded['path'];
$focus = (bool) ($decoded['focus'] ?? false);
if (! empty($decoded['disk'])) {
$tempDisk = $decoded['disk'];
}
}
} catch (\Throwable $e) {
// Fall back to session
}
}
}
if (! $path) {
$path = $request->session()->get(self::SESSION_FILE_PATH);
$focus = $request->session()->get(self::SESSION_FOCUS, false);
}
if (! $path || ! Storage::disk($tempDisk)->exists($path)) {
$request->session()->forget([self::SESSION_FILE_PATH, self::SESSION_ROWS, self::SESSION_FOCUS, 'resources_import_token']);
if (is_string($token ?? null) && $token !== '') {
Cache::forget('resources_import_' . $token);
}
$message = 'No verified file found. Please upload and verify a file first.';
if ($path && ! Storage::disk($tempDisk)->exists($path)) {
$message .= ' If you use multiple servers, set RESOURCES_IMPORT_TEMP_DISK=s3 in .env so the file is stored in shared storage.';
}
return redirect()->route('admin.resources-import.index')
->withErrors(['import' => $message]);
}
$edits = $request->input('edits', []);
if (! is_array($edits)) {
$edits = [];
}
$overrides = [];
$allowedKeys = [
'name_of_the_resource', 'link', 'description', 'image',
'filters_type', 'filters_target_audience', 'filters_level_of_difficulty',
'filters_programming_language', 'filters_subject', 'filters_topics', 'filters_language',
'category', 'group_name',
's3_suffix', 'file_suffix', 's3_file_suffix',
];
foreach ($edits as $index => $fields) {
if (! is_array($fields)) {
continue;
}
$rowOverrides = [];
foreach ($allowedKeys as $key) {
if (array_key_exists($key, $fields)) {
$value = $fields[$key];
if (is_scalar($value)) {
$rowOverrides[$key] = trim((string) $value);
} elseif (is_array($value)) {
$rowOverrides[$key] = $value;
}
}
}
if ($rowOverrides !== []) {
$overrides[(int) $index] = $rowOverrides;
}
}
$filenameMode = $request->input('filename_mode', 'per_file');
if (! is_string($filenameMode) || ! in_array($filenameMode, ['per_file', 'batch', 'stable', 'preserve'], true)) {
$filenameMode = 'per_file';
}
$batchTimestamp = $filenameMode === 'batch' ? time() : null;
$customSuffix = $request->input('custom_s3_suffix');
$customSuffix = is_string($customSuffix) ? trim($customSuffix) : '';
$customSuffix = $customSuffix !== '' ? $customSuffix : null;
try {
$result = new ResourcesImportResult;
$import = new ResourcesImport(null, null, $focus, $overrides, $result, $filenameMode, $batchTimestamp, $customSuffix);
Excel::import($import, $path, $tempDisk);
Storage::disk($tempDisk)->delete($path);
$request->session()->forget([self::SESSION_FILE_PATH, self::SESSION_ROWS, self::SESSION_FOCUS, 'resources_import_token']);
if (is_string($token = $request->input('import_token')) && $token !== '') {
Cache::forget('resources_import_' . $token);
}
$request->session()->flash('resources_import_report_created', $result->created);
$request->session()->flash('resources_import_report_updated', $result->updated);
$request->session()->flash('resources_import_report_failures', $result->failures);
return redirect()->route('admin.resources-import.report');
} catch (\Throwable $e) {
if (Storage::disk($tempDisk)->exists($path)) {
Storage::disk($tempDisk)->delete($path);
}
$request->session()->forget([self::SESSION_FILE_PATH, self::SESSION_ROWS, self::SESSION_FOCUS, 'resources_import_token']);
if (is_string($token = $request->input('import_token')) && $token !== '') {
Cache::forget('resources_import_' . $token);
}
return redirect()->route('admin.resources-import.preview')
->withErrors(['import' => 'Import failed: '.$e->getMessage()]);
}
}
/**
* Show the import report (GET). Data is flashed from import() redirect.
*/
public function report(Request $request): View|RedirectResponse
{
$created = $request->session()->get('resources_import_report_created');
$updated = $request->session()->get('resources_import_report_updated');
$failures = $request->session()->get('resources_import_report_failures');
if ($created === null && $updated === null && $failures === null) {
return redirect()->route('admin.resources-import.index')
->with('info', 'Report no longer available. Run an import to see a new report.');
}
return view('admin.resources-import.report', [
'created' => $created ?? [],
'updated' => $updated ?? [],
'failures' => $failures ?? [],
]);
}
}