blob: e9d49784f5dc63521397a9a0ae56307d381e147e (
plain)
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
|
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2022 Côme Chilliet <come.chilliet@nextcloud.com>
*
* @author Côme Chilliet <come.chilliet@nextcloud.com>
*
* @license GNU AGPL version 3 or any later version
*
* 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 <http://www.gnu.org/licenses/>.
*
*/
namespace OCP\UserMigration;
use OCP\Files\Folder;
/**
* @since 24.0.0
*/
interface IImportSource {
/**
* @since 24.0.0
*/
public const PATH_USER = 'user.json';
/**
* Reads a file from the export
*
* @param string $path Full path to the file in the export archive.
* @return string The full content of the file.
* @throws UserMigrationException
*
* @since 24.0.0
*/
public function getFileContents(string $path): string;
/**
* Reads a file from the export as a stream
*
* @param string $path Full path to the file in the export archive.
* @return resource A stream resource to read from to get the file content.
* @throws UserMigrationException
*
* @since 24.0.0
*/
public function getFileAsStream(string $path);
/**
* List the files of a folder
*
* @param string $path Full path to the folder in the export archive.
* @return array The list of files.
* @throws UserMigrationException
*
* @since 24.0.0
*/
public function getFolderListing(string $path): array;
/**
* Test if a path exists, which may be a file or a folder
*
* @throws UserMigrationException
*
* @since 24.0.0
*/
public function pathExists(string $path): bool;
/**
* Copy files from the export to a Folder
*
* Folder $destination folder to copy into
* string $sourcePath path in the export archive
*
* @throws UserMigrationException
*
* @since 24.0.0
*/
public function copyToFolder(Folder $destination, string $sourcePath): void;
/**
* @return array<string,int> Migrators and their versions from the export archive.
* @throws UserMigrationException
*
* @since 24.0.0
*/
public function getMigratorVersions(): array;
/**
* @return ?int Version for this migrator from the export archive. Null means migrator missing.
* @throws UserMigrationException
* @param string $migrator Migrator id (as returned by IMigrator::getId)
*
* @since 24.0.0
*/
public function getMigratorVersion(string $migrator): ?int;
/**
* Get original uid of the imported account
*
* @throws UserMigrationException
*
* @since 24.0.0
*/
public function getOriginalUid(): string;
/**
* Called after import is complete
*
* @throws UserMigrationException
*
* @since 24.0.0
*/
public function close(): void;
}
|
