Compare commits

...

21 Commits
main ... main

Author SHA1 Message Date
c0759f0cbe
add vscode folder to gitignore 2022-08-23 11:47:34 +03:00
47dc68028c Merge pull request 'make the endpoints at request time' (#9) from serve-on-request into main
Reviewed-on: yagich/tickle-godot-frontend#9
2022-07-04 20:04:06 +00:00
e44cac165a
sync http-server with upstream and properly check for endpoints 2022-07-04 06:44:00 +03:00
3d2fd37191
make the endpoints at request time 2022-07-03 23:37:47 +03:00
836c101e6f
properly update and use server_dir from ServerUI 2022-07-02 13:41:15 +03:00
8cbfffba94 Merge pull request 'add proper image handling to http server' (#7) from utf8-test into main
Reviewed-on: yagich/tickle-godot-frontend#7
2022-07-02 10:31:17 +00:00
7280277029
add proper image handling to http server 2022-07-02 02:11:29 +03:00
a203972157 update readme (#2) 2022-06-29 17:54:45 +03:00
7f7018f183 hide content preview container for now 2022-06-29 17:42:25 +03:00
44cfe464c5 change project title (#2) 2022-06-29 17:38:02 +03:00
df2dc1097e clean current file and tree item references when regenerating tree 2022-06-29 17:27:16 +03:00
68b4a03a3f implement refresh button 2022-06-29 16:53:46 +03:00
815aae5a4d implement open in browser button 2022-06-29 16:22:53 +03:00
6a98956b03 update to godot 3.5rc5 2022-06-29 16:15:46 +03:00
0602345af9 remove warnings in ServerUI 2022-06-29 16:14:14 +03:00
c8d19197e6 add newline to files.txt after stripping right edge 2022-06-29 14:02:37 +03:00
45cf485d9d disable file tree context menu while server is running 2022-06-29 13:55:44 +03:00
741e23af56 strip right edge when making files.txt 2022-06-29 13:51:46 +03:00
2284a1d1dd remove conditional when disabling nodes 2022-06-29 13:44:52 +03:00
d309c40fc3 disable file tree editing while server is running 2022-06-29 13:37:03 +03:00
fc1ca1e1b0 format MimeTypeHelper 2022-06-29 13:36:41 +03:00
10 changed files with 179 additions and 97 deletions

3
.gitignore vendored
View File

@ -9,3 +9,6 @@ export_presets.cfg
# Mono-specific ignores
.mono/
data_*/
# VSCode config folder
.vscode/

49
Main.gd
View File

@ -17,26 +17,7 @@ func _start_server(port: int = 3001) -> void:
return
_server = HTTPServer.new()
var dir := Directory.new()
if dir.open(server_dir) == OK:
if dir.list_dir_begin() != OK:
# TODO: show error to user here
return
var file_name := dir.get_next()
while file_name != "":
if !dir.current_is_dir():
if file_name.get_extension() == "import":
file_name = dir.get_next()
continue
print(file_name)
_server.endpoint(HTTPServer.Method.GET, "/%s" % file_name, funcref(self, "_serve_file"), [file_name])
file_name = dir.get_next()
_server.endpoint(HTTPServer.Method.GET, "/", funcref(self, "_serve_file"), ["index.html"])
_server.endpoint(HTTPServer.Method.GET, "/", funcref(self, "_serve_file"))
if _server.listen(port) != OK:
# TODO: show error to user here
@ -62,27 +43,25 @@ func _process(_delta: float) -> void:
return
func _serve_file(_request: HTTPServer.Request, response: HTTPServer.Response, binds: Array) -> void:
var file_name: String = binds[0] as String
print(file_name)
func _serve_file(request: HTTPServer.Request, response: HTTPServer.Response) -> void:
var file_name: String = request.endpoint()
if file_name == "/": # if the request is for root, serve index
file_name = "index.html"
var f := File.new()
var success = f.open("res://server_files/%s" % file_name, File.READ)
if success == OK:
var success = f.open(server_dir.plus_file(file_name), File.READ)
if success == OK: # TODO: handle other errors like file not found
var mime := mime_types.get(file_name)
response.header("content-type", mime.full_type)
response.type(mime)
# variant
# warning-ignore:incompatible_ternary
var data = f.get_as_text() if mime.type == 'text' else f.get_buffer(f.get_len())
var data = f.get_buffer(f.get_len())
response.data(data)
else:
response.header("content-type", "text/plain")
response.data("500 - Read Error")
response.type(mime_types.get("txt"))
response.status(500)
response.data("Internal Server Error")
func _on_ServerUI_start_server_button_pressed(port: int, new_dir: String) -> void:
@ -92,3 +71,7 @@ func _on_ServerUI_start_server_button_pressed(port: int, new_dir: String) -> voi
func _on_ServerUI_stop_server_button_pressed() -> void:
_stop_server()
func _on_ServerUI_server_folder_changed(new_path: String) -> void:
server_dir = new_path

View File

@ -10,5 +10,6 @@ script = ExtResource( 1 )
[node name="ServerUI" parent="." instance=ExtResource( 2 )]
[connection signal="server_folder_changed" from="ServerUI" to="." method="_on_ServerUI_server_folder_changed"]
[connection signal="start_server_button_pressed" from="ServerUI" to="." method="_on_ServerUI_start_server_button_pressed"]
[connection signal="stop_server_button_pressed" from="ServerUI" to="." method="_on_ServerUI_stop_server_button_pressed"]

View File

@ -1,9 +1,9 @@
# Godot frontend for Ticle
# Godot frontend for Tickle
Ticle is a WIP tiny static site "generator" that parses Markdown files right in the browser, with no compilation to HTML necessary, intended for equally tiny blogs.
Tickle is a WIP tiny static site "generator" that parses Markdown files right in the browser, with no compilation to HTML necessary, intended for equally tiny blogs.
This project aims to provide a nice frontend/UI to manage Ticle files and an easy way to run your site locally.
This project aims to provide a nice frontend/UI to manage Tickle files and an easy way to run your site locally.
It uses a slightly modified version of [godot-http-server](https://github.com/velopman/godot-http-server) for the server side.
The version of Godot used for this project is 3.5rc4.
The version of Godot used for this project is 3.5rc5.

View File

@ -1,11 +1,16 @@
extends Control
const SERVER_STATUS_TEXT: Dictionary = {
"RUNNING": "Server is running!",
"NOT_RUNNING": "Server is not running."
true: "Server is running!",
false: "Server is not running.",
}
const ACCEPTED_FILE_FORMATS := ["md"] # server should ignore these file types when adding endpoints
const START_BUTTON_SERVER_TEXT: Dictionary = {
true: "Stop server",
false: "Start server",
}
const ACCEPTED_FILE_FORMATS := ["md"]
export(bool) var enable_file_autosave := true # if true, will save the active file's contents every save_file_timeout seconds.
export(float) var save_file_timeout := 4.0 # the time to save document content after the edited signal of TextEdit
@ -19,6 +24,7 @@ onready var server_path_label := $"%ServerPathLabel"
onready var port_spin_box := $"%PortSpinBox"
onready var start_server_button := $"%StartServerButton"
onready var server_status_label := $"%ServerStatusLabel"
onready var open_browser_button := $"%OpenBrowserButton"
onready var document_title_lineedit := $"%DocTitleLineEdit"
onready var document_date_lineedit := $"%DocDateLineEdit"
@ -32,12 +38,12 @@ onready var content_preview_richtextlabel := $"%ContentPreviewRichTextLabel"
onready var server_folder_dialog := $"%ServerFolderDialog"
signal server_folder_changed(new_path) # new_path: String
signal server_port_changed(new_port) # new_port: int
signal start_server_button_pressed(port, path) # port: int, path: String
signal stop_server_button_pressed() # emit from %StartServerButton, when the server is not running.
signal open_browser_button_pressed(port) # port: int
signal files_selection_changed(new_files) # new_files: Array<String>
#signal server_port_changed(new_port) # new_port: int
#signal open_browser_button_pressed(port) # port: int
#signal files_selection_changed(new_files) # new_files: Array<String>
var server_dir: String setget set_server_dir
var is_server_running: bool = false setget set_server_running
@ -68,9 +74,10 @@ func set_server_dir(dir: String) -> void:
var directory := Directory.new()
if directory.open(dir) == OK:
directory.list_dir_begin()
if directory.list_dir_begin() != OK:
push_error("Directory error") # TODO: show a user-facing error
var file_name: String = directory.get_next()
var idx: int = 0
while file_name != "":
if !directory.current_is_dir() && (file_name.get_extension() in ACCEPTED_FILE_FORMATS):
var fd = FileDef(file_name, false)
@ -84,16 +91,18 @@ func set_server_dir(dir: String) -> void:
fd.title = file_metadata["title"]
fd.date = file_metadata["date"]
idx += 1
file_name = directory.get_next()
directory.list_dir_end()
_reconstruct_tree_from_working_files()
emit_signal("server_folder_changed", server_dir)
func _reconstruct_tree_from_working_files() -> void:
current_file = null
current_tree_selection = null
file_tree.clear()
var root: TreeItem = file_tree.create_item()
root.set_text(0, "Server files")
@ -128,6 +137,11 @@ func _on_FileTree_item_selected() -> void:
func _on_FileTree_item_rmb_selected(position: Vector2) -> void:
current_tree_selection = file_tree.get_selected()
file_tree_context_menu.rect_position = position + file_tree.rect_global_position
file_tree_context_menu.popup()
if is_server_running:
return # the file tree can't be edited while the server is running, so disable moving items as well
if (current_tree_selection.get_metadata(0)["id"] as int) == 0:
file_tree_context_menu.set_item_disabled(ContextMenuOptions.MOVE_UP, true)
else:
@ -139,29 +153,23 @@ func _on_FileTree_item_rmb_selected(position: Vector2) -> void:
file_tree_context_menu.set_item_disabled(ContextMenuOptions.MOVE_DOWN, false)
file_tree_context_menu.popup()
func _on_OpenServerFolderButton_pressed() -> void:
server_folder_dialog.popup()
func set_server_running(running: bool) -> void:
is_server_running = running
if is_server_running:
server_status_label.text = SERVER_STATUS_TEXT.RUNNING
start_server_button.text = "Stop server"
port_spin_box.editable = false
document_date_lineedit.editable = false
document_title_lineedit.editable = false
document_input_textedit.readonly = true
else:
server_status_label.text = SERVER_STATUS_TEXT.NOT_RUNNING
start_server_button.text = "Start server"
port_spin_box.editable = !false
document_date_lineedit.editable = !false
document_title_lineedit.editable = !false
document_input_textedit.readonly = !true
port_spin_box.editable = !running
document_date_lineedit.editable = !running
document_title_lineedit.editable = !running
document_input_textedit.readonly = running
open_browser_button.disabled = !running
_set_file_tree_disabled(running)
_set_context_menu_disabled(running)
server_status_label.text = SERVER_STATUS_TEXT[running]
start_server_button.text = START_BUTTON_SERVER_TEXT[running]
func _generate_filestxt():
@ -170,7 +178,7 @@ func _generate_filestxt():
for file in working_files:
file = file as FileDef
if file.include_in_filestxt:
files += "%s %s %s\n" % [file.file_path, file.date, file.title]
files += ("%s %s %s" % [file.file_path, file.date, file.title]).strip_edges(false, true) + "\n"
var f := File.new()
if f.open(server_dir.plus_file("files.txt"), File.WRITE) == OK:
@ -235,6 +243,25 @@ func _get_file_content(path: String) -> String:
return content
func _set_file_tree_disabled(disabled: bool) -> void:
var root = file_tree.get_root()
var tree_item = root.get_children() as TreeItem
while tree_item != null:
tree_item.set_editable(0, !disabled)
tree_item = tree_item.get_next()
func _set_context_menu_disabled(disabled: bool) -> void:
for i in file_tree_context_menu.get_item_count():
file_tree_context_menu.set_item_disabled(i, disabled)
func _commit_all_files() -> void:
for file in working_files:
file = file as FileDef
file.commit(server_dir)
func _on_FileTreeContextMenu_id_pressed(id: int) -> void:
var idx = current_tree_selection.get_metadata(0)["id"] as int
var fd = working_files[idx] as FileDef
@ -259,6 +286,17 @@ func _on_DocDateLineEdit_text_changed(new_text: String) -> void:
current_file.date = new_text
func _on_OpenBrowserButton_pressed() -> void:
if OS.shell_open("http://localhost:%s" % port_spin_box.value) != OK:
push_error("Error opening browser!") # TODO: show a user-facing error
func _on_RefreshFilesButton_pressed() -> void:
_commit_all_files()
_generate_filestxt()
self.server_dir = server_dir
func _on_DocInputTextEdit_text_changed() -> void:
if current_file:
var new_text: String = document_input_textedit.text
@ -270,6 +308,7 @@ func _on_DocInputTextEdit_text_changed() -> void:
t.one_shot = true
current_file.timer = t
add_child(t)
# warning-ignore:return_value_discarded
t.connect("timeout", self, "_on_EditedTimeout_timeout", [t, current_file])
else:
current_file.timer.stop()
@ -280,9 +319,7 @@ func _on_EditedTimeout_timeout(timer: Timer, file: FileDef) -> void:
file.timer = null
timer.queue_free()
var f := File.new()
if f.open(server_dir.plus_file(file.file_path), File.WRITE) == OK:
f.store_string(file.content)
file.commit(server_dir)
func FileDef(
@ -308,3 +345,15 @@ class FileDef:
var content: String
var timer: Timer
func commit(server_dir: String) -> void:
var f := File.new()
var open := f.open(server_dir.plus_file(file_path), File.WRITE)
if open == OK:
f.store_string(content)
if timer && !timer.is_stopped(): # if there's an autosave pending, stop it since we're setting it here.
timer.stop()
else:
push_error("Error committing file %s, code %s" % [file_path, open]) # TODO: show a user-facing error

View File

@ -78,11 +78,13 @@ margin_bottom = 23.0
text = "Server is not running."
[node name="OpenBrowserButton" type="Button" parent="VBoxContainer/HBoxContainer"]
unique_name_in_owner = true
margin_left = 922.0
margin_right = 1040.0
margin_bottom = 32.0
rect_min_size = Vector2( 0, 32 )
size_flags_horizontal = 12
disabled = true
text = "Open in browser"
[node name="HSplitContainer" type="HSplitContainer" parent="VBoxContainer"]
@ -188,19 +190,19 @@ size_flags_vertical = 3
split_offset = 328
[node name="ContentEditContainer" type="VBoxContainer" parent="VBoxContainer/HSplitContainer/VBoxContainer/HBoxContainer/VBoxContainer/HSplitContainer"]
margin_right = 378.0
margin_right = 848.0
margin_bottom = 514.0
size_flags_vertical = 3
[node name="Label" type="Label" parent="VBoxContainer/HSplitContainer/VBoxContainer/HBoxContainer/VBoxContainer/HSplitContainer/ContentEditContainer"]
margin_right = 378.0
margin_right = 848.0
margin_bottom = 14.0
text = "Content"
[node name="DocInputTextEdit" type="TextEdit" parent="VBoxContainer/HSplitContainer/VBoxContainer/HBoxContainer/VBoxContainer/HSplitContainer/ContentEditContainer"]
unique_name_in_owner = true
margin_top = 18.0
margin_right = 378.0
margin_right = 848.0
margin_bottom = 514.0
size_flags_horizontal = 3
size_flags_vertical = 3
@ -208,6 +210,7 @@ show_line_numbers = true
wrap_enabled = true
[node name="ContentPreviewContainer" type="VBoxContainer" parent="VBoxContainer/HSplitContainer/VBoxContainer/HBoxContainer/VBoxContainer/HSplitContainer"]
visible = false
margin_left = 390.0
margin_right = 848.0
margin_bottom = 514.0
@ -248,6 +251,8 @@ items = [ "Move Up", null, 0, false, false, 0, 0, null, "", false, "Move Down",
[connection signal="pressed" from="VBoxContainer/HBoxContainer/OpenServerFolderButton" to="." method="_on_OpenServerFolderButton_pressed"]
[connection signal="pressed" from="VBoxContainer/HBoxContainer/StartServerButton" to="." method="_on_StartServerButton_pressed"]
[connection signal="pressed" from="VBoxContainer/HBoxContainer/OpenBrowserButton" to="." method="_on_OpenBrowserButton_pressed"]
[connection signal="pressed" from="VBoxContainer/HSplitContainer/VBoxContainer2/HBoxContainer2/RefreshFilesButton" to="." method="_on_RefreshFilesButton_pressed"]
[connection signal="item_edited" from="VBoxContainer/HSplitContainer/VBoxContainer2/FileTree" to="." method="_on_FileTree_item_edited"]
[connection signal="item_rmb_selected" from="VBoxContainer/HSplitContainer/VBoxContainer2/FileTree" to="." method="_on_FileTree_item_rmb_selected"]
[connection signal="item_selected" from="VBoxContainer/HSplitContainer/VBoxContainer2/FileTree" to="." method="_on_FileTree_item_selected"]

View File

@ -13,7 +13,7 @@ const Status = preload("res://addons/http_server/status.gd")
var __endpoints: Dictionary = {
# key: [Int, String], array with 0 index representing method, 1 index representing endpoint
# value: [FuncRef, Array], index 0 = reference to function to call, index 1 = binds to pass to func
# value: FuncRef, reference to function to call
}
var __fallback: FuncRef = null
var __server: TCP_Server = null
@ -32,7 +32,7 @@ func endpoint(type: int, endpoint: String, function: FuncRef, binds: Array = [])
)
return
__endpoints[endpoint_hash] = [function, binds]
__endpoints[endpoint_hash] = function
func fallback(function: FuncRef) -> void:
@ -106,7 +106,7 @@ func __process_connection(connection: StreamPeerTCP) -> void:
body = PoolStringArray(body_parts).join("\r\n")
var response: Response = __process_request(method, endpoint, headers, body)
connection.put_data(response.to_utf8())
connection.put_data(response.get_data())
func __process_request(method: String, endpoint: String, headers: Dictionary, body: String) -> Response:
@ -121,22 +121,15 @@ func __process_request(method: String, endpoint: String, headers: Dictionary, bo
var endpoint_func: FuncRef = null
var endpoint_parts: PoolStringArray = endpoint.split("/", false)
var binds
# special case for if endpoint is just root
if endpoint == "/":
var endpoint_hash: Array = [type, "/"]
while !endpoint_func:
var endpoint_hash: Array = [type, "/" + endpoint_parts.join("/")]
if __endpoints.has(endpoint_hash):
endpoint_func = __endpoints[endpoint_hash][0]
binds = __endpoints[endpoint_hash][1]
else:
while (!endpoint_func && !endpoint_parts.empty()):
var endpoint_hash: Array = [type, "/" + endpoint_parts.join("/")]
if __endpoints.has(endpoint_hash):
endpoint_func = __endpoints[endpoint_hash][0]
binds = __endpoints[endpoint_hash][1]
else:
endpoint_parts.remove(endpoint_parts.size() - 1)
endpoint_func = __endpoints[endpoint_hash]
elif endpoint_parts.empty():
break
else:
endpoint_parts.remove(endpoint_parts.size() - 1)
if !endpoint_func:
@ -160,10 +153,7 @@ func __process_request(method: String, endpoint: String, headers: Dictionary, bo
"[INF] Recieved request method: %s, endpoint: %s" % [method, endpoint]
)
if !binds:
endpoint_func.call_func(request, response)
else:
endpoint_func.call_func(request, response, binds)
endpoint_func.call_func(request, response)
return response

View File

@ -11,7 +11,7 @@ enum SOURCE{
const UTF8 := "UTF-8"
class MimeType:
var full_type := "application/octet-stream"
var type := "application"
var sub_type := "octet-stream"
@ -49,20 +49,20 @@ class MimeTypeDb:
func process_raw_db(raw_db: Dictionary) -> void:
for type in raw_db:
var mime_type := MimeType.new()
mime_type.setup(type, raw_db[type])
if not mime_type.extensions or type == _default_mime_type.type:
continue;
for extension in mime_type.extensions:
if extension in _types and (_types[extension] as MimeType).source > mime_type.source:
continue
_types[extension] = mime_type
func get(ext_or_filename: String) -> MimeType:
var ext := ("x."+ext_or_filename.trim_prefix(".")).get_extension().to_lower()
if not (ext in _types):

View File

@ -11,6 +11,7 @@ var __headers: Dictionary = {
# value: Variant, header value
}
var __status: int = 200
var __type: MimeTypeHelper.MimeType
# Public methods
@ -32,6 +33,10 @@ func status(status: int) -> void:
__status = status
func type(type: MimeTypeHelper.MimeType) -> void:
__type = type
func to_utf8() -> PoolByteArray:
var content = PoolStringArray()
@ -45,6 +50,7 @@ func to_utf8() -> PoolByteArray:
data = JSON.print(data)
__headers['content-length'] = len(data)
__headers["content-type"] = "application/octet-stream" if !__type else __type.full_type
for header in __headers:
content.append("%s: %s" % [header, String(__headers[header])])
@ -55,3 +61,48 @@ func to_utf8() -> PoolByteArray:
content.append(data)
return content.join("\r\n").to_utf8()
func get_data() -> PoolByteArray:
var res = __response_headers()
var data = __data
if !data:
return res
var type: MimeTypeHelper.MimeType = __type
if !type:
type = MimeTypeHelper.MimeType.new()
if data is String: # else, assume data is PoolByteArray
data = data.to_utf8()
res.append_array(data)
return res
# Private methods
func __response_headers() -> PoolByteArray:
var res = PoolStringArray()
res.append(Status.code_to_status_line(__status))
var data = __data
if !data:
data = Status.code_to_description(__status)
__headers["content-length"] = len(data)
__headers["content-type"] = "application/octet-stream" if !__type else __type.full_type
for header in __headers:
res.append("%s: %s" % [header, String(__headers[header])])
res.append("")
var s = res.join("\r\n")
s = s + "\r\n"
return s.to_utf8()

View File

@ -26,7 +26,7 @@ _global_script_class_icons={
[application]
config/name="Ticle Frontend"
config/name="Tickle Frontend"
run/main_scene="res://Main.tscn"
config/icon="res://icon.png"