1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
|
JWebmail
========
This is based on concepts of oMail by Oliver Müller <om@omnis.ch>.
JWebmail is a webmail server build on top of Mojolicious.
This includes:
- Using a Perl web framework and leave the deprecated CGI behind. You can
still use it in a CGI setup if you like but you now have the option of
plack/psgi and fcgi as well as the build in server hypnotoad.
- Set up a MVC architecture instead of a single file.
- Improve security by only running a small part of the model with elevated
privileges.
- Make sure it works well with sqmail and its authuser authenticator and
maildir but also permit other setups (currently not supported but adding
more should be easy). Maybe I even add a POP or IMAP based back-ends instead
of reading them from disk.
## License
JWebmail is available under the GNU General Public License version 3.
## JWebmail-webmail - INSTALL
You need a moderately new version of Perl (v5.22+)
You need access to CPAN.
You need to install sqmail.
It is recommended to use an external web server like Apache or Nginx.
Posts
-----
- Complain about IPC::Open2 ignoring 'open' pragma
- Complain about undef references causing errors, and non-fine granular
switch no strict 'refs'
- Thank for perldoc.org
I18N patch url_for
------------------
I have taken the monkey patching approach that was taken by
Mojolicious::Plugin::I18N. I used `can` to get the old method for looser
coupling and used the Mojo::Util::monkey_patch instead of manually doing it.
This is probably overkill.
I'm desperately looking for a different approach. Yeah the monkey patching
works great, but it violates the open-closed principal. But I cannot find
an appropriate alternative. Extending the controller and overriding url_for
does not work cleanly as the user directly inherits from Mojolicious::Controller.
Also going the 'better' approach of solving at the root by using an extension
of Mojolicious::Routes::Match->path_for and supplying it to the controller
by setting match does not work as it is on the one hand extremely difficult
to inject it in the first place and the attribute is overwritten in the
dispatching process anyways. One issue when taking the Match approach is
that it needs knowledge of the stash values which can cause cyclic references.
I thought of three approaches injecting the modified Match instance into the class:
1. Extending the Mojolicious::Controller and overriding the new method.
This has the issue that inheritance is static but one can use Roles that
are dynamically consumed.
2. Overriding build_controller in Mojolicious. To make this cleanly it needs
to be monkey patched by the plugin which is exactly what we want to avoid. :(
3. The matcher can be set in a hook relatively early in its lifetime and
hooks compose well.
A completely different option is to use the router directly and register a
global route that has the language as parameter. But omitting the language
leads to problems.
One can use a redirect on root. Very easy but also not very effective.
I am now using a global route containing the language after the changes to
matching have been published. No need to monkey_patch and it works well enough.
## Concepts
Logging Mojo::Log
Object system Mojo::Base and Role::Tiny
Exceptions
Configuration Plugin::INIConfig
Static server Mojolicious::Static
Application server
(De-)Serialization
# Controller
Router Mojolicious::Routes
Middleware (auth) Mojo under
Controller/Handler Mojolicious::Controller
HTTP Req/Resp
Sessions Mojo::Sessions (cookies) and Plugin::ServerSideSessionData
Validation Mojo::Validator
# View
Templates Plugin::EPRenderer
View extensions Mojolicious::Renderer
Pagination self developed
I18N Plugin::I18N2
CSS Framework Pure CSS
Frontend crypto (for CRAM)
# Model
Maildir client
Mail sending
# Development
Testing prove/Test::More
Debug printing Data::Dumper
Development server Mojo::Morbo
Frontend package manager NPM
Frontend build tool esbuild
Backend package manager CPAN
Backend build tool ExtUtils::MakeMaker
Task runner action.sh
Dependencies
------------
- Role::Tiny
- Class::Metod::Modifiers
- Mojolicious
- Config::Tiny
- Crypt::URandom
- Digest::HMAC_MD5
- (for Model)
- Mail::Box::Manager
- Email::MIME
## Architecture
Process overview
Webserver <--> Application
Server
|
Application <--> Extractor
The Webserver acts as a proxy to the Application Server.
The Extractor is a stateless process that reads mails from a source.
## Extractor Interface Definition
Stateless Service - `net.fehcom.JWebmail.QMAuth.Maildir.repository` v0.1.0
struct MailAddress {
display_name: unicode_text,
address: unicode_text,
}
struct TopHead {
byte_size: uint64,
unread: bool,
date_received: iso8601,
message_handle: unicode_text,
head: Head,
}
struct Head {
date: iso8601,
from: Array[MailAddress],
sender: Array[MailAddress],
reply_to: Array[MailAddress],
to: Array[MailAddress],
cc: Array[MailAddress],
bcc: Array[MailAddress],
subject: unicode_text,
comments: unicode_text,
keywords: unicode_text,
mime: MIMEHeader,
}
sturct MIMEHeader {
content_maintype: unicode_text,
content_subtype: unicode_text,
content_disposition: unicode_text,
filename: unicode_text,
}
struct MIMEPart {
head: MIMEHeader,
body: Body,
}
enum Body {
discrete(unicode_text),
multipart{
preamble: unicode_text,
parts: Array[MIMEPart],
epilogue: unicode_text,
},
message(Message),
}
// body is either a string (discrete), an array (multipart) or object (message)
// depending on the content type
struct Message {
head: Head,
body: Body,
}
struct CountResult {
byte_size: uint64,
total_mails: uint32,
unread_mails: uint32,
}
fn __start__(maildir_directory: filepath, os_user: unicode_text, mail_user: unicode_text)
fn list(subfolder: unicode_text, start: uint32, end: uint32, sort_by: unicode_text) -> Array[TopHead]
fn count(folder: unicode_text) -> CountResult
fn read(folder: unicode_text, mid: unicode_text) -> Message
fn folders() -> Array[unicode_text]
fn move(mid: unicode_text, from_folder: unicode_text, to_folder: unicode_text)
fn search(pattern: unicode_text, folder: unicode_text) -> Array[Message]
|
