/* * SPDX-FileCopyrightText: 2019-2021 Vishesh Handa * * SPDX-License-Identifier: Apache-2.0 */ import 'package:path/path.dart' as p; import 'package:universal_io/io.dart' as io; import 'package:uuid/uuid.dart'; import 'package:gitjournal/core/folder/notes_folder_fs.dart'; import 'package:gitjournal/editors/common_types.dart'; import 'package:gitjournal/error_reporting.dart'; import 'package:gitjournal/logger/logger.dart'; import 'package:gitjournal/settings/settings.dart'; import 'package:gitjournal/utils/datetime.dart'; import 'file/file.dart'; import 'folder/notes_folder_config.dart'; import 'md_yaml_doc.dart'; import 'note_serializer.dart'; typedef NoteSelectedFunction = void Function(Note note); typedef NoteBoolPropertyFunction = bool Function(Note note); enum NoteType { Unknown, Checklist, Journal, Org } class NoteFileFormatInfo { final NotesFolderConfig config; NoteFileFormatInfo(this.config); static String defaultExtension(NoteFileFormat format) { switch (format) { case NoteFileFormat.Markdown: return ".md"; case NoteFileFormat.OrgMode: return '.org'; case NoteFileFormat.Txt: return ".txt"; } } static EditorType defaultEditor(NoteFileFormat format) { switch (format) { case NoteFileFormat.Markdown: return EditorType.Markdown; case NoteFileFormat.Txt: return EditorType.Raw; case NoteFileFormat.OrgMode: return EditorType.Org; } } static NoteFileFormat fromFilePath(String filePath) { var ext = p.extension(filePath).toLowerCase(); switch (ext) { case ".md": return NoteFileFormat.Markdown; case ".org": return NoteFileFormat.OrgMode; case ".txt": default: return NoteFileFormat.Txt; } } bool isAllowedFileName(String filePath) { var noteFilePath = filePath.toLowerCase(); for (var ext in config.allowedFileExts) { if (p.extension(noteFilePath) == ext) { return true; } } return false; } } // FIXME: Treat Markdown and Markdown + YAML differently enum NoteFileFormat { Markdown, OrgMode, Txt, } class Note implements File { NotesFolderFS parent; String? _filePath; String _title = ""; DateTime? _created; DateTime? _modified; String _body = ""; NoteType _type = NoteType.Unknown; Set _tags = {}; Map _extraProps = {}; NoteFileFormat _fileFormat; MdYamlDoc _data = MdYamlDoc(); late NoteSerializer noteSerializer; late File file; @override DateTime get fileLastModified => file.fileLastModified; @override GitHash get oid => file.oid; @override String get repoPath => file.repoPath; @override String get fullFilePath => p.join(repoPath, filePath); Note.build({ required this.parent, required this.file, required String title, required String body, required NoteType noteType, required Set tags, required Map extraProps, required NoteFileFormat fileFormat, required MdYamlDoc doc, required NoteSerializationSettings serializerSettings, required DateTime? modified, required DateTime? created, }) : _filePath = file.filePath, _title = title, _body = body, _type = noteType, _tags = tags, _extraProps = extraProps, _fileFormat = fileFormat, _data = doc, _modified = modified, _created = created, noteSerializer = NoteSerializer.fromConfig(serializerSettings); Note.newNote( this.parent, { required NoteFileFormat fileFormat, Map extraProps = const {}, String? fileName, }) : file = File.empty(repoPath: parent.repoPath), _fileFormat = fileFormat { _created = DateTime.now(); var settings = NoteSerializationSettings.fromConfig(parent.config); noteSerializer = NoteSerializer.fromConfig(settings); if (extraProps.isNotEmpty) { extraProps.forEach((key, value) { _data.props[key] = value; }); var newNote = noteSerializer.decode(data: _data, file: file, parent: parent); _body = newNote._body; _created = newNote._created; _modified = newNote._modified; _title = newNote._title; _tags = newNote._tags; _type = newNote._type; } if (fileName != null) { // FIXME: We should ensure a note with this fileName does not already // exist var formatInfo = NoteFileFormatInfo(parent.config); if (!formatInfo.isAllowedFileName(fileName)) { fileName += NoteFileFormatInfo.defaultExtension(_fileFormat); } _filePath = p.join(parent.folderPath, fileName); Log.i("Constructing new note with path $_filePath"); assert(!fileName.endsWith(p.separator)); assert(!parent.folderPath.endsWith(p.separator)); assert(!parent.fullFolderPath.endsWith(p.separator)); assert(p.dirname(fullFilePath) == parent.fullFolderPath); file = file.copyFile(filePath: filePath); } } @override String get filePath { if (_filePath == null) { var fp = ""; try { fp = p.join(parent.folderPath, _buildFileName()); } catch (e, stackTrace) { Log.e("_buildFileName: $e"); logExceptionWarning(e, stackTrace); fp = p.join(parent.folderPath, const Uuid().v4()); } switch (_fileFormat) { case NoteFileFormat.OrgMode: if (!fp.toLowerCase().endsWith('.org')) { fp += '.org'; } break; case NoteFileFormat.Txt: if (!fp.toLowerCase().endsWith('.txt')) { fp += '.txt'; } break; case NoteFileFormat.Markdown: default: if (!fp.toLowerCase().endsWith('.md')) { fp += '.md'; } break; } _filePath = fp; file = file.copyFile(filePath: _filePath); } return _filePath as String; } void applyFilePath(String filePath) { assert(!filePath.startsWith(p.separator)); bool changed = false; var newFormat = NoteFileFormatInfo.fromFilePath(filePath); if (_filePath != filePath || newFormat != _fileFormat) { _filePath = filePath; _fileFormat = newFormat; print(_fileFormat); print(_filePath); file = file.copyFile(filePath: _filePath); changed = true; } if (changed) { _notifyModified(); } } void apply({ DateTime? created, DateTime? modified, String? body, String? title, NoteType? type, Map? extraProps, Set? tags, }) { var changed = false; if (canHaveMetadata) { if (created != null && created != _created) { _created = created; changed = true; } if (modified != null && modified != _modified) { _modified = modified; changed = true; } if (type != null && type != _type) { _type = type; changed = true; } if (extraProps != null) { _extraProps = extraProps; changed = true; } if (tags != null) { _tags = tags; changed = true; } } if (body != null && body != _body) { _body = body; changed = true; } if (title != null && title != _title) { _title = title; changed = true; } if (changed) { _notifyModified(); } } Note copyWith({ String? filePath, DateTime? created, DateTime? modified, String? body, String? title, NoteType? type, Map? extraProps, Set? tags, NoteFileFormat? fileFormat, File? file, }) { return Note.build( body: body ?? this.body, parent: parent, doc: data, file: file ?? this.file, created: created, modified: modified, title: title ?? this.title, noteType: type ?? this.type, extraProps: extraProps ?? this.extraProps, tags: tags ?? this.tags, fileFormat: fileFormat ?? this.fileFormat, serializerSettings: noteSerializer.settings.clone(), ); } @override String get fileName { return p.basename(filePath); } @override DateTime get created { return _created ?? file.created; } @override DateTime get modified { return _modified ?? file.modified; } void updateModified() { _modified = DateTime.now(); _notifyModified(); } String get body { return _body; } String get title { return _title; } NoteType get type { return _type; } Set get tags { return _tags; } Map get extraProps { return _extraProps; } bool get canHaveMetadata { if (_fileFormat == NoteFileFormat.Txt || _fileFormat == NoteFileFormat.OrgMode) { return false; } return parent.config.yamlHeaderEnabled; } MdYamlDoc get data { noteSerializer.encode(this, _data); return _data; } bool get pinned => extraProps["pinned"] == true; @override int get hashCode => _filePath.hashCode; @override bool operator ==(Object other) => identical(this, other) || other is Note && runtimeType == other.runtimeType && _filePath == other._filePath && _data == other._data; @override String toString() { return 'Note{filePath: $_filePath, created: $created, modified: $modified, data: $_data}'; } void _notifyModified() { parent.noteModified(this); } String _buildFileName() { var date = created; var isJournal = type == NoteType.Journal; var ext = NoteFileFormatInfo.defaultExtension(_fileFormat); switch (!isJournal ? parent.config.fileNameFormat : parent.config.journalFileNameFormat) { case NoteFileNameFormat.SimpleDate: return toSimpleDateTime(date); case NoteFileNameFormat.DateOnly: var dateStr = toDateString(date); return ensureFileNameUnique(parent.fullFolderPath, dateStr, ext); case NoteFileNameFormat.FromTitle: if (title.isNotEmpty) { return buildTitleFileName(parent.fullFolderPath, title, ext); } else { return toSimpleDateTime(date); } case NoteFileNameFormat.Iso8601: return toIso8601(date); case NoteFileNameFormat.Iso8601WithTimeZone: return toIso8601WithTimezone(date); case NoteFileNameFormat.Iso8601WithTimeZoneWithoutColon: return toIso8601WithTimezone(date).replaceAll(":", "_"); case NoteFileNameFormat.UuidV4: return const Uuid().v4(); case NoteFileNameFormat.Zettelkasten: return toZettleDateTime(date); } return date.toString(); } NoteFileFormat get fileFormat => _fileFormat; @override Map toMap() { return file.toMap(); } @override File copyFile({ GitHash? oid, String? filePath, DateTime? modified, DateTime? created, DateTime? fileLastModified, }) { return File( oid: oid ?? this.oid, filePath: filePath ?? this.filePath, repoPath: repoPath, modified: modified ?? this.modified, created: created ?? this.created, fileLastModified: fileLastModified ?? this.fileLastModified, ); } } String ensureFileNameUnique(String parentDir, String name, String ext) { var fileName = name + ext; var fullPath = p.join(parentDir, fileName); assert(fullPath.startsWith(p.separator)); var file = io.File(fullPath); if (!file.existsSync()) { return fileName; } for (var i = 1;; i++) { var fileName = name + "_$i$ext"; var fullPath = p.join(parentDir, fileName); var file = io.File(fullPath); if (!file.existsSync()) { return fileName; } } } String buildTitleFileName(String parentDir, String title, String ext) { // Sanitize the title - these characters are not allowed in Windows title = title.replaceAll(RegExp(r'[/<\>":|?*]'), '_'); return ensureFileNameUnique(parentDir, title, ext); }