phpmyadmin/src/Encoding.php at master · DDd-Devops/phpmyadmin · GitHub

History

321 lines (275 loc) · 7.97 KB

Raw

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

318

319

320

321

<?php

declare(strict_types=1);

namespace PhpMyAdmin;

use function array_intersect;

use function array_map;

use function explode;

use function fclose;

use function feof;

use function fgets;

use function fopen;

use function function_exists;

use function fwrite;

use function iconv;

use function mb_convert_encoding;

use function mb_convert_kana;

use function mb_detect_encoding;

use function mb_list_encodings;

use function strtolower;

use function tempnam;

use function unlink;

/**

* Encoding conversion helper class

class Encoding

{

/**

* None encoding conversion engine

public const ENGINE_NONE = 0;

/**

* iconv encoding conversion engine

public const ENGINE_ICONV = 1;

/**

* mbstring encoding conversion engine

public const ENGINE_MB = 3;

/**

* Chosen encoding engine

private static int|null $engine = null;

/**

* Map of conversion engine configurations

* Each entry contains:

* - function to detect

* - engine contant

* - extension name to warn when missing

* @var mixed[]

private static array $enginemap = [

'iconv' => ['iconv', self::ENGINE_ICONV, 'iconv'],

'mb' => ['mb_convert_encoding', self::ENGINE_MB, 'mbstring'],

'none' => ['isset', self::ENGINE_NONE, ''],

];

/**

* Order of automatic detection of engines

* @var mixed[]

private static array $engineorder = ['iconv', 'mb'];

/**

* Kanji encodings list

private static string $kanjiEncodings = 'ASCII,SJIS,EUC-JP,JIS';

/**

* Initializes encoding engine detecting available backends.

public static function initEngine(): void

{

$engine = 'auto';

$config = Config::getInstance();

if (isset($config->settings['RecodingEngine'])) {

$engine = $config->settings['RecodingEngine'];

}

/* Use user configuration */

if (isset(self::$enginemap[$engine])) {

if (function_exists(self::$enginemap[$engine][0])) {

self::$engine = self::$enginemap[$engine][1];

return;

}

Core::warnMissingExtension(self::$enginemap[$engine][2]);

}

/* Autodetection */

foreach (self::$engineorder as $engine) {

if (function_exists(self::$enginemap[$engine][0])) {

self::$engine = self::$enginemap[$engine][1];

return;

}

/* Fallback to none conversion */

self::$engine = self::ENGINE_NONE;

}

/**

* Setter for engine. Use with caution, mostly useful for testing.

* @param int $engine Engine encoding

public static function setEngine(int $engine): void

{

self::$engine = $engine;

}

/**

* Checks whether there is any charset conversion supported

public static function isSupported(): bool

{

if (self::$engine === null) {

self::initEngine();

}

return self::$engine != self::ENGINE_NONE;

}

/**

* Converts encoding of text according to parameters with detected

* conversion function.

* @param string $srcCharset source charset

* @param string $destCharset target charset

* @param string $what what to convert

* @return string converted text

public static function convertString(

string $srcCharset,

string $destCharset,

string $what,

): string {

if ($srcCharset === $destCharset) {

return $what;

}

if (self::$engine === null) {

self::initEngine();

}

return match (self::$engine) {

self::ENGINE_ICONV => iconv(

$srcCharset,

$destCharset . (Config::getInstance()->settings['IconvExtraParams'] ?? ''), $what,

self::ENGINE_MB => mb_convert_encoding($what, $destCharset, $srcCharset),

default => $what,

};

}

/**

* Detects whether Kanji encoding is available

public static function canConvertKanji(): bool

{

return $GLOBALS['lang'] === 'ja';

}

/**

* Setter for Kanji encodings. Use with caution, mostly useful for testing.

public static function getKanjiEncodings(): string

{

return self::$kanjiEncodings;

}

/**

* Setter for Kanji encodings. Use with caution, mostly useful for testing.

* @param string $value Kanji encodings list

public static function setKanjiEncodings(string $value): void

{

self::$kanjiEncodings = $value;

}

/**

* Reverses SJIS & EUC-JP position in the encoding codes list

public static function kanjiChangeOrder(): void

{

$parts = explode(',', self::$kanjiEncodings);

if ($parts[1] === 'EUC-JP') {

self::$kanjiEncodings = 'ASCII,SJIS,EUC-JP,JIS';

return;

}

self::$kanjiEncodings = 'ASCII,EUC-JP,SJIS,JIS';

}

/**

* Kanji string encoding convert

* @param string $str the string to convert

* @param string $enc the destination encoding code

* @param string $kana set 'kana' convert to JIS-X208-kana

* @return string the converted string

public static function kanjiStrConv(string $str, string $enc, string $kana): string

{

if ($enc === '' && $kana === '') {

return $str;

}

$stringEncoding = mb_detect_encoding($str, self::$kanjiEncodings);

if ($stringEncoding === false) {

$stringEncoding = 'utf-8';

}

if ($kana === 'kana') {

$dist = mb_convert_kana($str, 'KV', $stringEncoding);

$str = $dist;

}

if ($stringEncoding !== $enc && $enc !== '') {

return mb_convert_encoding($str, $enc, $stringEncoding);

}

return $str;

}

/**

* Kanji file encoding convert

* @param string $file the name of the file to convert

* @param string $enc the destination encoding code

* @param string $kana set 'kana' convert to JIS-X208-kana

* @return string the name of the converted file

public static function kanjiFileConv(string $file, string $enc, string $kana): string

{

if ($enc === '' && $kana === '') {

return $file;

}

$tmpfname = (string) tempnam(Config::getInstance()->getUploadTempDir(), $enc);

$fpd = fopen($tmpfname, 'wb');

if ($fpd === false) {

return $file;

}

$fps = fopen($file, 'r');

if ($fps === false) {

return $file;

}

self::kanjiChangeOrder();

while (! feof($fps)) {

$line = fgets($fps, 4096);

if ($line === false) {

continue;

}

$dist = self::kanjiStrConv($line, $enc, $kana);

fwrite($fpd, $dist);

}

self::kanjiChangeOrder();

fclose($fps);

fclose($fpd);

unlink($file);

return $tmpfname;

}

/**

* Defines radio form fields to switch between encoding modes

* @return string HTML code for the radio controls

public static function kanjiEncodingForm(): string

{

$template = new Template();

return $template->render('encoding/kanji_encoding_form');

}

/**

* Lists available encodings.

* @return mixed[]

public static function listEncodings(): array

{

if (self::$engine === null) {

self::initEngine();

}

/* Most engines do not support listing */

$config = Config::getInstance();

if (self::$engine != self::ENGINE_MB) {

return $config->settings['AvailableCharsets'];

}

return array_intersect(

array_map(strtolower(...), mb_list_encodings()),

$config->settings['AvailableCharsets'],

);

}

phpmyadmin/src/Encoding.php at master · DDd-Devops/phpmyadmin · GitHub

Uh oh!

Expand file tree

Breadcrumbs

Encoding.php

Latest commit

History

Breadcrumbs

Encoding.php

File metadata and controls