Skip to content

Commit a05d685

Browse files
felixarntzfelixarntz
committed
Implement several helper API methods related to dealing with binary files, blobs, and data URLs.
1 parent aed69c1 commit a05d685

File tree

5 files changed

+243
-22
lines changed

5 files changed

+243
-22
lines changed

‎examples/add-image-alt-text-plugin/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ function ImageControls( { attributes, setAttributes } ) {
5555
setInProgress( true );
5656

5757
const mimeType = getMimeType( attributes.url );
58-
const base64Image = await helpers.base64EncodeFile( attributes.url );
58+
const base64Image = await helpers.fileToBase64DataUrl( attributes.url );
5959

6060
let candidates;
6161
try {

‎includes/Services/API/Helpers.php

+63-10
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,14 @@
99
namespace Felix_Arntz\AI_Services\Services\API;
1010

1111
use Felix_Arntz\AI_Services\Services\API\Enums\Content_Role;
12+
use Felix_Arntz\AI_Services\Services\API\Types\Blob;
1213
use Felix_Arntz\AI_Services\Services\API\Types\Candidates;
1314
use Felix_Arntz\AI_Services\Services\API\Types\Content;
1415
use Felix_Arntz\AI_Services\Services\API\Types\Parts;
1516
use Felix_Arntz\AI_Services\Services\API\Types\Parts\Text_Part;
1617
use Felix_Arntz\AI_Services\Services\Util\Formatter;
1718
use Generator;
19+
use InvalidArgumentException;
1820
use WP_Post;
1921

2022
/**
@@ -82,7 +84,7 @@ public static function text_and_attachment_to_content( string $text, $attachment
8284

8385
$parts = new Parts();
8486
$parts->add_text_part( $text );
85-
$parts->add_inline_data_part( $mime_type, self::base64_encode_file( $file, $mime_type ) );
87+
$parts->add_inline_data_part( $mime_type, self::file_to_base64_data_url( $file, $mime_type ) );
8688

8789
return Formatter::format_content( $parts, $role );
8890
}
@@ -203,7 +205,7 @@ public static function process_candidates_stream( Generator $generator ): Candid
203205
}
204206

205207
/**
206-
* Base64-encodes a file and returns its data URL.
208+
* Returns the base64-encoded data URL representation of the given file URL.
207209
*
208210
* @since n.e.x.t
209211
*
@@ -212,18 +214,69 @@ public static function process_candidates_stream( Generator $generator ): Candid
212214
* be prefixed with `data:{mime_type};base64,`. Default empty string.
213215
* @return string The base64-encoded file data URL, or empty string on failure.
214216
*/
215-
public static function base64_encode_file( string $file, string $mime_type = '' ): string {
216-
// phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
217-
$binary_data = file_get_contents( $file );
218-
if ( ! $binary_data ) {
217+
public static function file_to_base64_data_url( string $file, string $mime_type = '' ): string {
218+
$blob = self::file_to_blob( $file, $mime_type );
219+
if ( ! $blob ) {
219220
return '';
220221
}
221222

223+
return self::blob_to_base64_data_url( $blob );
224+
}
225+
226+
/**
227+
* Returns the binary data blob representation of the given file URL.
228+
*
229+
* @since n.e.x.t
230+
*
231+
* @param string $file Absolute path to the file, or its URL.
232+
* @param string $mime_type Optional. The MIME type of the file. If provided, the automatically detected MIME type
233+
* will be overwritten. Default empty string.
234+
* @return Blob|null The binary data blob, or null on failure.
235+
*/
236+
public static function file_to_blob( string $file, string $mime_type = '' ): ?Blob {
237+
try {
238+
return Blob::from_file( $file, $mime_type );
239+
} catch ( InvalidArgumentException $e ) {
240+
return null;
241+
}
242+
}
243+
244+
/**
245+
* Returns the base64-encoded data URL representation of the given binary data blob.
246+
*
247+
* @since n.e.x.t
248+
*
249+
* @param Blob $blob The binary data blob.
250+
* @return string The base64-encoded file data URL, or empty string on failure.
251+
*/
252+
public static function blob_to_base64_data_url( Blob $blob ): string {
222253
// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode
223-
$base64 = base64_encode( $binary_data );
224-
if ( '' !== $mime_type ) {
225-
$base64 = "data:$mime_type;base64,$base64";
254+
$base64 = base64_encode( $blob->get_binary_data() );
255+
$mime_type = $blob->get_mime_type();
256+
return "data:$mime_type;base64,$base64";
257+
}
258+
259+
/**
260+
* Returns the binary data blob representation of the given base64-encoded data URL.
261+
*
262+
* @since n.e.x.t
263+
*
264+
* @param string $base64_data_url The base64-encoded data URL.
265+
* @return Blob|null The binary data blob, or null on failure.
266+
*/
267+
public static function base64_data_url_to_blob( string $base64_data_url ): ?Blob {
268+
if ( ! preg_match( '/^data:([a-z0-9-]+\/[a-z0-9-]+);base64,/', $base64_data_url, $matches ) ) {
269+
return null;
226270
}
227-
return $base64;
271+
272+
$base64 = substr( $base64_data_url, strlen( $matches[0] ) );
273+
274+
// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode
275+
$binary_data = base64_decode( $base64 );
276+
if ( false === $binary_data ) {
277+
return null;
278+
}
279+
280+
return new Blob( $binary_data, $matches[1] );
228281
}
229282
}

‎includes/Services/API/Types/Blob.php

+103
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
<?php
2+
/**
3+
* Class Felix_Arntz\AI_Services\Services\API\Types\Blob
4+
*
5+
* @since n.e.x.t
6+
* @package ai-services
7+
*/
8+
9+
namespace Felix_Arntz\AI_Services\Services\API\Types;
10+
11+
use InvalidArgumentException;
12+
13+
/**
14+
* Simple value class representing a binary data blob, e.g. from a file.
15+
*
16+
* @since n.e.x.t
17+
*/
18+
final class Blob {
19+
20+
/**
21+
* The binary data of the blob.
22+
*
23+
* @since n.e.x.t
24+
* @var string
25+
*/
26+
private $binary_data;
27+
28+
/**
29+
* The MIME type of the blob.
30+
*
31+
* @since n.e.x.t
32+
* @var string
33+
*/
34+
private $mime_type;
35+
36+
/**
37+
* Constructor.
38+
*
39+
* @since n.e.x.t
40+
*
41+
* @param string $binary_data The binary data of the blob.
42+
* @param string $mime_type The MIME type of the blob.
43+
*/
44+
public function __construct( string $binary_data, string $mime_type ) {
45+
$this->binary_data = $binary_data;
46+
$this->mime_type = $mime_type;
47+
}
48+
49+
/**
50+
* Retrieves the binary data of the blob.
51+
*
52+
* @since n.e.x.t
53+
*
54+
* @return string The binary data.
55+
*/
56+
public function get_binary_data(): string {
57+
return $this->binary_data;
58+
}
59+
60+
/**
61+
* Retrieves the MIME type of the blob.
62+
*
63+
* @since n.e.x.t
64+
*
65+
* @return string The MIME type.
66+
*/
67+
public function get_mime_type(): string {
68+
return $this->mime_type;
69+
}
70+
71+
/**
72+
* Creates a new blob instance from a file.
73+
*
74+
* @since n.e.x.t
75+
*
76+
* @param string $file The file path or URL.
77+
* @param string $mime_type Optional. MIME type, to override the automatic detection. Default empty string.
78+
* @return Blob The blob instance.
79+
*
80+
* @throws InvalidArgumentException Thrown if the file could not be read or if the MIME type cannot be determined.
81+
*/
82+
public static function from_file( string $file, string $mime_type = '' ): self {
83+
// phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
84+
$blob = file_get_contents( $file );
85+
if ( ! $blob ) {
86+
throw new InvalidArgumentException(
87+
sprintf( 'Could not read file %s.', esc_html( $file ) )
88+
);
89+
}
90+
91+
if ( ! $mime_type ) {
92+
$file_type = wp_check_filetype( $file );
93+
if ( ! $file_type['type'] ) {
94+
throw new InvalidArgumentException(
95+
sprintf( 'Could not determine MIME type of file %s.', esc_html( $file ) )
96+
);
97+
}
98+
$mime_type = $file_type['type'];
99+
}
100+
101+
return new self( $blob, $mime_type );
102+
}
103+
}

‎src/ai/helpers.js

+75-10
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ export async function textAndAttachmentToContent(
3939
role = ContentRole.USER
4040
) {
4141
const mimeType = attachment.mime;
42-
const data = await base64EncodeFile(
42+
const data = await fileToBase64DataUrl(
4343
attachment.sizes?.large?.url || attachment.url
4444
);
4545

@@ -162,7 +162,7 @@ export function processCandidatesStream( generator ) {
162162
}
163163

164164
/**
165-
* Base64-encodes a file and returns its data URL.
165+
* Returns the base64-encoded data URL representation of the given file URL.
166166
*
167167
* @since n.e.x.t
168168
*
@@ -171,11 +171,47 @@ export function processCandidatesStream( generator ) {
171171
* be prefixed with `data:{mime_type};base64,`. Default empty string.
172172
* @return {string} The base64-encoded file data URL, or empty string on failure.
173173
*/
174-
export async function base64EncodeFile( file, mimeType = '' ) {
174+
export async function fileToBase64DataUrl( file, mimeType = '' ) {
175+
const blob = await fileToBlob( file, mimeType );
176+
if ( ! blob ) {
177+
return '';
178+
}
179+
180+
return blobToBase64DataUrl( blob );
181+
}
182+
183+
/**
184+
* Returns the binary data blob representation of the given file URL.
185+
*
186+
* @since n.e.x.t
187+
*
188+
* @param {string} file The file URL.
189+
* @param {string} mimeType Optional. The MIME type of the file. If provided, the automatically detected MIME type will
190+
* be overwritten. Default empty string.
191+
* @return {Blob?} The binary data blob, or null on failure.
192+
*/
193+
export async function fileToBlob( file, mimeType = '' ) {
175194
const data = await fetch( file );
176195
const blob = await data.blob();
196+
if ( ! blob ) {
197+
return null;
198+
}
199+
if ( mimeType && mimeType !== blob.type ) {
200+
return new Blob( [ blob ], { type: mimeType } );
201+
}
202+
return blob;
203+
}
177204

178-
const base64 = await new Promise( ( resolve ) => {
205+
/**
206+
* Returns the base64-encoded data URL representation of the given binary data blob.
207+
*
208+
* @since n.e.x.t
209+
*
210+
* @param {Blob} blob The binary data blob.
211+
* @return {string} The base64-encoded data URL, or empty string on failure.
212+
*/
213+
export async function blobToBase64DataUrl( blob ) {
214+
const base64DataUrl = await new Promise( ( resolve ) => {
179215
const reader = new window.FileReader();
180216
reader.readAsDataURL( blob );
181217
reader.onloadend = () => {
@@ -184,11 +220,40 @@ export async function base64EncodeFile( file, mimeType = '' ) {
184220
};
185221
} );
186222

187-
if ( mimeType ) {
188-
return base64.replace(
189-
/^data:[a-z0-9-]+\/[a-z0-9-]+;base64,/,
190-
`data:${ mimeType };base64,`
191-
);
223+
return base64DataUrl;
224+
}
225+
226+
/**
227+
* Returns the binary data blob representation of the given base64-encoded data URL.
228+
*
229+
* @since n.e.x.t
230+
*
231+
* @param {string} base64DataUrl The base64-encoded data URL.
232+
* @return {Blob?} The binary data blob, or null on failure.
233+
*/
234+
export async function base64DataUrlToBlob( base64DataUrl ) {
235+
const prefixMatch = base64DataUrl.match(
236+
/^data:([a-z0-9-]+\/[a-z0-9-]+);base64,/
237+
);
238+
if ( ! prefixMatch ) {
239+
return null;
240+
}
241+
242+
const base64Data = base64DataUrl.substring( prefixMatch[ 0 ].length );
243+
const binaryData = atob( base64Data );
244+
const byteArrays = [];
245+
246+
for ( let offset = 0; offset < binaryData.length; offset += 512 ) {
247+
const slice = binaryData.slice( offset, offset + 512 );
248+
249+
const byteNumbers = new Array( slice.length );
250+
for ( let i = 0; i < slice.length; i++ ) {
251+
byteNumbers[ i ] = slice.charCodeAt( i );
252+
}
253+
byteArrays.push( new Uint8Array( byteNumbers ) );
192254
}
193-
return base64;
255+
256+
return new Blob( byteArrays, {
257+
type: prefixMatch[ 1 ],
258+
} );
194259
}

‎src/playground-page/store/messages.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ const parseContentFromCache = async ( content, attachment ) => {
4646
...part,
4747
inlineData: {
4848
...part.inlineData,
49-
data: await helpers.base64EncodeFile(
49+
data: await helpers.fileToBase64DataUrl(
5050
attachment.sizes?.large?.url || attachment.url
5151
),
5252
},

0 commit comments

Comments
 (0)