Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v1.7.31 - Improve APIDBModule #121

Merged
merged 4 commits into from
Nov 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
## 1.7.31

- `HTMLInput._resolveInput`: ensure that `DataTime` values are UTC.

- `APIDBModule`:
- Added `_addScriptFixDateTime` and `_fixParametersDateTime` (used by `insert`).
- `_writeInputTable`: id with link to the `select` route.
- `select`:
- Show entry index.
- JSON url with query parameters.

## 1.7.30

- `APITestConfigDockerDB`:
Expand Down
2 changes: 1 addition & 1 deletion lib/src/bones_api_base.dart
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ typedef APILogger = void Function(APIRoot apiRoot, String type, String? message,
/// Bones API Library class.
class BonesAPI {
// ignore: constant_identifier_names
static const String VERSION = '1.7.30';
static const String VERSION = '1.7.31';

static bool _boot = false;

Expand Down
118 changes: 113 additions & 5 deletions lib/src/bones_api_db_module.dart
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ import 'package:logging/logging.dart' as logging;
import 'package:reflection_factory/reflection_factory.dart';
import 'package:statistics/statistics.dart';

import 'bones_api_authentication.dart';
import 'bones_api_base.dart';
import 'bones_api_entity.dart';
import 'bones_api_entity_reference.dart';
import 'bones_api_entity_rules.dart';
import 'bones_api_extension.dart';
import 'bones_api_html_document.dart';
import 'bones_api_module.dart';
import 'bones_api_authentication.dart';
import 'bones_api_utils_json.dart';

final _log = logging.Logger('APIDBModule');
Expand Down Expand Up @@ -347,15 +347,18 @@ class APIDBModule extends APIModule {
content.add('<table class="center">');

content.add('<thead><tr>');
content.add('<td style="text-align: left">#</td>');
for (var e in fieldsEntries) {
content.add('<td style="text-align: center">${e.key}</td>');
}
content.add(
'<td style="text-align: center; min-width: 100px;">[operations]</td>');
content.add('</tr></thead>');

var i = 0;
for (var o in list) {
content.add('<tr>');
content.add('<td>$i</td>');

for (var e in fieldsEntries) {
var fieldName = e.key;
Expand Down Expand Up @@ -402,15 +405,16 @@ class APIDBModule extends APIModule {
}

content.add('</tr>');
++i;
}

content.add(
'<tr><td colspan="${fieldsEntries.length + 1}" style="text-align: right"><a href="${basePath}insert/$repoName">&nbsp;+&nbsp;</a></td></tr>');
'<tr><td colspan="${fieldsEntries.length + 2}" style="text-align: right"><a href="${basePath}insert/$repoName">&nbsp;+&nbsp;</a></td></tr>');

content.add('</table>');

content.add(
'<br><div style="width: 100%; text-align: center;"><i><a href="${basePath}select/$repoName/json">JSON</a></i></div>');
'<br><div style="width: 100%; text-align: center;"><i><a href="${basePath}select/$repoName/json${query.isNotEmpty ? '?$query' : ''}">JSON</a></i></div>');

htmlDoc.content = content;

Expand Down Expand Up @@ -484,8 +488,12 @@ class APIDBModule extends APIModule {

var content = [];

var parameters = apiRequest.parameters;
_addScriptFixDateTime(content);

var parameters = Map<String, dynamic>.from(apiRequest.parameters);
if (parameters.isNotEmpty) {
_fixParametersDateTime(parameters);

var entity2 = await entityHandler.createFromMap(parameters,
entityProvider: entityRepository.provider,
resolutionRules: EntityResolutionRules(allowEntityFetch: true));
Expand Down Expand Up @@ -527,6 +535,8 @@ class APIDBModule extends APIModule {
}

content.add('<form method="post">');
content.add(
'<input id="LOCAL_TIMEZONE" type="hidden" name="__LOCAL_TIMEZONE__">');

_writeInputTable(entityRepository, content, entity);

Expand All @@ -535,13 +545,100 @@ class APIDBModule extends APIModule {

content.add('</form>');

content.add(
"<script type='application/javascript'> setLocalTimeZone() ; fixAllInputsDateTimeToLocal() ;</script>");

htmlDoc.content = content;

var html = htmlDoc.build();

return APIResponse.ok(html, mimeType: 'html');
}

void _fixParametersDateTime(Map<String, dynamic> parameters) {
var localTimeZoneStr = parameters.remove('__LOCAL_TIMEZONE__');

if (localTimeZoneStr != null) {
var localTimeZoneMin = TypeParser.parseInt(localTimeZoneStr);

if (localTimeZoneMin != null && localTimeZoneMin != 0) {
for (var e in parameters.entries) {
var key = e.key;
var value = e.value;

if (value is String &&
RegExp(r'^\d\d\d\d-\d\d-\d\dT\d\d:\d\d(?::\d\d)?Z?$')
.hasMatch(value)) {
var d = TypeParser.parseDateTime(value);
if (d != null) {
var d2 = DateTime.utc(
d.year, d.month, d.day, d.hour, d.minute, d.second);
var d3 = d2.add(Duration(minutes: localTimeZoneMin));
parameters[key] = d3;
}
}
}
}
}
}

void _addScriptFixDateTime(List<dynamic> content) {
content.add(r'''
<script type="application/javascript">
function toLocalISOString(date) {
const year = date.getFullYear();
const month = String(date.getMonth() + 1).padStart(2, '0'); // Months are 0-based
const day = String(date.getDate()).padStart(2, '0');
const hours = String(date.getHours()).padStart(2, '0');
const minutes = String(date.getMinutes()).padStart(2, '0');
const seconds = String(date.getSeconds()).padStart(2, '0');
const s = year + '-' + month + '-' + day + 'T' + hours + ':' + minutes + ':' + seconds;
return s;
}

function fixInputDateTimeToLocal(input) {
let dStr = input.value;
if (dStr.length < 16) {
return ;
}

const d = new Date(dStr);
console.log(d);

const dLocal = new Date(Date.UTC(
d.getFullYear(),
d.getMonth(),
d.getDate(),
d.getHours(),
d.getMinutes(),
d.getSeconds()
));

console.log(dLocal);

const dLocalStr = toLocalISOString(dLocal);
input.value = dLocalStr;
console.log("-- Fixed DataTime: "+ dStr + " -> "+ dLocalStr);
}

function fixAllInputsDateTimeToLocal() {
const inputs = document.querySelectorAll('input[type="datetime-local"]');

inputs.forEach(input => {
fixInputDateTimeToLocal(input);
});
}

function setLocalTimeZone() {
const offsetMinutes = new Date().getTimezoneOffset();
const inputLocalTimeZone = document.querySelector('#LOCAL_TIMEZONE');
inputLocalTimeZone.value = offsetMinutes;
console.log("-- LOCAL_TIMEZONE: "+ offsetMinutes +" min");
}
</script>
''');
}

void _writeEntityJson(EntityHandler entityHandler, Type entityType,
Object entity, List content) {
var json = entityHandler.toJson(entity);
Expand All @@ -563,17 +660,28 @@ class APIDBModule extends APIModule {
content.add(
'<tr><td colspan="3"><h2>${entityRepository.type}:</h2></td></tr>');

var repoName = entityRepository.name;
var idFieldName = entityHandler.idFieldName(entity);

for (var e in fieldsEntries) {
var name = e.key;
var type = e.value;

var isID = name == idFieldName;

Object? value;
if (entity != null) {
value = entityHandler.getField(entity, name);
}

content.add('<tr><td style="text-align: right; vertical-align: top;">');
content.add('$name: &nbsp;\n');

if (isID && value != null) {
var href = '${basePath}select/$repoName?id==$value';
content.add('<a href="$href">$name</a>: &nbsp;\n');
} else {
content.add('$name: &nbsp;\n');
}

content.add('</td><td>');

Expand Down
3 changes: 3 additions & 0 deletions lib/src/bones_api_html_document.dart
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,9 @@ class HTMLInput {
var d = TypeParser.parseDateTime(value);
String? dStr;
if (d != null) {
if (!d.isUtc) {
d = d.toUtc();
}
dStr = d.toIso8601String();
var idx = dStr.lastIndexOf(':');
assert(idx > 4);
Expand Down
2 changes: 1 addition & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: bones_api
description: Bones_API - A powerful API backend framework for Dart. It comes with a built-in HTTP Server, route handler, entity handler, SQL translator, and DB adapters.
version: 1.7.30
version: 1.7.31
homepage: https://github.com/Colossus-Services/bones_api

environment:
Expand Down
Loading