-
Notifications
You must be signed in to change notification settings - Fork 77
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
Refactoring and update of dependencied #55
Open
gustawdaniel
wants to merge
6
commits into
jcreigno:master
Choose a base branch
from
gustawdaniel:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
1916651
Var replaced by let and consts in all files
gustawdaniel a338901
Utit.inherits removed because of is discouraged
gustawdaniel 69057f0
Defined sets of events of imap and notifier
gustawdaniel 683df88
Imap and Notifier events replaced by constants
gustawdaniel 3a6e1a0
Events for Fetch and Message saved as const
gustawdaniel 628ad1c
Packages async, debug and imap updated to latest version
gustawdaniel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,3 @@ | ||
| /node_modules/ | ||
| .idea | ||
| package-lock.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,149 +1,228 @@ | ||
| /*jslint node: true, vars: true, indent: 4 */ | ||
| /*jslint node: true, consts: true, indent: 4 */ | ||
| 'use strict'; | ||
|
|
||
| var util = require('util'), | ||
| Imap = require('imap'), | ||
| const Imap = require('imap'), | ||
| debug = require('debug'), | ||
| async = require('async'), | ||
| MailParser = require('mailparser').MailParser, | ||
| EventEmitter = require('events').EventEmitter; | ||
| MailParser = require('mailparser').MailParser, // version 0.6.2 is depreciated | ||
| // I asked about docs of migration there: https://github.com/nodemailer/mailparser/issues/209 | ||
| // all versions https://www.npmjs.com/package/mailparser?activeTab=versions | ||
| // you can see that it can be updated to 2.4.3 | ||
| EventEmitter = require('events'); // https://nodejs.org/api/events.html | ||
|
|
||
| var dbg = debug('mailnotifier'); | ||
| const defaultDebug = debug('mailnotifier'); | ||
|
|
||
| function Notifier(opts, dbg) { | ||
| EventEmitter.call(this); | ||
| var self = this; | ||
| self.options = opts; | ||
| if (self.options.username) { //backward compat | ||
| self.options.user = self.options.username; | ||
| /** | ||
| * Connection events from imap package, these strings should be used on imap listening | ||
| * | ||
| * source: | ||
| * https://www.npmjs.com/package/imap | ||
| */ | ||
| const CONNECTION_EVENT_READY = 'ready'; | ||
| // () - Emitted when a connection to the server has been made and authentication was successful. | ||
| const CONNECTION_EVENT_ALERT= 'alert'; | ||
| // (< string >message) - Emitted when the server issues an alert (e.g. "the server is going down for maintenance"). | ||
| const CONNECTION_EVENT_MAIL = 'mail'; | ||
| // (< integer >numNewMsgs) - Emitted when new mail arrives in the currently open mailbox. | ||
| const CONNECTION_EVENT_EXPUNGE = 'expunge'; | ||
| // (< integer >seqno) - Emitted when a message was expunged externally. seqno is the sequence number (instead of the | ||
| // unique UID) of the message that was expunged. If you are caching sequence numbers, all sequence numbers higher than | ||
| // this value MUST be decremented by 1 in order to stay synchronized with the server and to keep correct continuity. | ||
| const CONNECTION_EVENT_UIDVALIDITY = 'uidvalidity'; | ||
| // (< integer >uidvalidity) - Emitted if the UID validity value for the currently open mailbox changes during the | ||
| // current session. | ||
| const CONNECTION_EVENT_UPDATE = 'update'; | ||
| // (< integer >seqno, < object >info) - Emitted when message metadata (e.g. flags) changes externally. | ||
| const CONNECTION_EVENT_ERROR = 'error'; | ||
| // (< Error >err) - Emitted when an error occurs. The 'source' property will be set to indicate where the error | ||
| // originated from. | ||
| const CONNECTION_EVENT_CLOSE = 'close'; | ||
| // (< boolean >hadError) - Emitted when the connection has completely closed. | ||
| const CONNECTION_EVENT_END = 'end'; | ||
| // () - Emitted when the connection has ended. | ||
|
|
||
| /** | ||
| * ImapMessage events from imap package (emitting object is called msgEmitter in imap package) | ||
| * | ||
| * source | ||
| * https://www.npmjs.com/package/imap | ||
| */ | ||
| const MESSAGE_EVENT_BODY = 'body'; | ||
| // (< ReadableStream >stream, < object >info) - Emitted for each requested body. | ||
| const MESSAGE_EVENT_ATTRIBUTES = 'attributes'; | ||
| // (< object >attrs) - Emitted when all message attributes have been collected | ||
| const MESSAGE_EVENT_END = 'end'; | ||
| // () - Emitted when all attributes and bodies have been parsed. | ||
|
|
||
| /** | ||
| * ImapFetch events from imap package (emitting object is called bodyEmitter and is property of _curReq) | ||
| * | ||
| * source | ||
| * https://www.npmjs.com/package/imap | ||
| */ | ||
| const FETCH_EVENT_MESSAGE = 'message'; | ||
| // (< ImapMessage >msg, < integer >seqno) - Emitted for each message resulting from a fetch request. | ||
| // seqno is the message's sequence number. | ||
| const FETCH_EVENT_ERROR = 'error'; | ||
| // (< Error >err) - Emitted when an error occurred. | ||
| const FETCH_EVENT_END = 'end'; | ||
| // () - Emitted when all messages have been parsed. | ||
|
|
||
| /** | ||
| * This package events | ||
| * | ||
| * source: | ||
| * README.md | ||
| */ | ||
| const NOTIFIER_EVENT_CONNECTED = 'connected'; | ||
| // Sent when a connection to the server has been made. | ||
| const NOTIFIER_EVENT_MAIL = 'mail'; | ||
| // (< object > mail) - Sent on incoming new unread email. The parsed Mail is given as first parameter to the event listener. | ||
| const NOTIFIER_EVENT_ERROR = 'error'; | ||
| // (< object > err) - Sent when an error occurs with the IMAP connection. The first parameter is the err object. | ||
| const NOTIFIER_EVENT_END = 'end'; | ||
| // Sent when the IMAP connection is closed. This usually happens after a stop method call. | ||
|
|
||
| class Notifier extends EventEmitter { | ||
|
|
||
| constructor(opts, dbg) { // this not creates new connection, only configure notifier | ||
| super(); | ||
| const self = this; | ||
| self.dbg = defaultDebug; | ||
| self.options = opts; | ||
| if (self.options.username) { //backward compatibility | ||
| self.options.user = self.options.username; | ||
| } | ||
| self.options.box = self.options.box || 'INBOX'; | ||
| self.options.debug = self.options.debug || debug('imap'); | ||
|
|
||
| if (dbg) { | ||
| self.dbg = dbg; | ||
| } | ||
| } | ||
| self.options.box = self.options.box || 'INBOX'; | ||
| self.options.debug = self.options.debug || debug('imap'); | ||
|
|
||
| if(dbg) { | ||
| self.dbg = dbg; | ||
| start() { // this is real entry point of program | ||
| const self = this; | ||
|
|
||
| // we creating queue that will call scan mailbox, in practice task is only for debug and callback too | ||
| // to configure scanning you should use option `search` in configuration object forwarded to constructor | ||
| // q - queue object - https://caolan.github.io/async/docs.html#QueueObject | ||
| const q = async.queue(function(task, callback) { // docs: https://caolan.github.io/async/docs.html#queue | ||
| self.dbg('process queue ' + task.name); | ||
| self.scan(callback); | ||
| }); | ||
|
|
||
| // a callback that is called when the last item from the queue has returned from the worker | ||
| q.drain = function() { | ||
| self.dbg('all items have been processed'); | ||
| }; | ||
|
|
||
| // we configuring connection | ||
| self.imap = new Imap(self.options); | ||
| self.imap.once(CONNECTION_EVENT_END, function () { // all end of connection should be intercepted by notifier | ||
| self.dbg('imap end'); | ||
| self.emit(NOTIFIER_EVENT_END); | ||
| }); | ||
| self.imap.once(CONNECTION_EVENT_ERROR, function (err) { // similarly error of connection | ||
| self.dbg('imap error : %s', err); | ||
| self.emit(NOTIFIER_EVENT_ERROR, err); | ||
| }); | ||
| self.imap.once(CONNECTION_EVENT_CLOSE, function (hasError) { // potentially bugged connection breaks | ||
| self.dbg('imap close : %s', hasError ? 'errored ' + hasError : 'normal'); | ||
| self.emit(NOTIFIER_EVENT_END); // are treated as end for notifier, it potentially allow to reconnect | ||
| }); | ||
| self.imap.on(CONNECTION_EVENT_UIDVALIDITY, function (uidValidity) { // uidvalidity is captured but nothing happens there | ||
| self.dbg('new uidvalidity : %s', uidValidity); | ||
| }); | ||
| self.imap.once(CONNECTION_EVENT_READY, function () { | ||
| self.emit(NOTIFIER_EVENT_CONNECTED); | ||
| self.imap.openBox(self.options.box, false, function (err, box) { | ||
| if (err) { | ||
| self.dbg('unable to open box : %s', err); | ||
| self.emit(NOTIFIER_EVENT_ERROR, err); | ||
| return; | ||
| } | ||
|
|
||
| q.push({name: 'scan initial'}, function(err) { | ||
| self.dbg('finished processing scan initial'); | ||
| }); | ||
|
|
||
| self.imap.on(CONNECTION_EVENT_MAIL, function (id) { | ||
| self.dbg('mail event : %s', id); | ||
| q.push({name: 'scan', id : id}, function(err) { | ||
| self.dbg('finished processing scan '+id); | ||
| }); | ||
| }); | ||
| }); | ||
| }); | ||
| self.imap.connect(); | ||
| return this; | ||
| } | ||
| } | ||
| util.inherits(Notifier, EventEmitter); | ||
|
|
||
| module.exports = function (opts, customDbg) { | ||
| return new Notifier(opts, customDbg); | ||
| }; | ||
|
|
||
| Notifier.prototype.start = function () { | ||
| var self = this; | ||
|
|
||
| var q = async.queue(function(task, callback) { | ||
| self.dbg('process queue ' + task.name); | ||
| self.scan(callback); | ||
| }, 1); | ||
|
|
||
| // assign a callback | ||
| q.drain = function() { | ||
| self.dbg('all items have been processed'); | ||
| }; | ||
|
|
||
| self.imap = new Imap(self.options); | ||
| self.imap.once('end', function () { | ||
| self.dbg('imap end'); | ||
| self.emit('end'); | ||
| }); | ||
| self.imap.once('error', function (err) { | ||
| self.dbg('imap error : %s', err); | ||
| self.emit('error', err); | ||
| }); | ||
| self.imap.once('close', function (haserr) { | ||
| self.dbg('imap close : %s', haserr ? 'errored ' + haserr : 'normal'); | ||
| self.emit('end'); | ||
| }); | ||
| self.imap.on('uidvalidity', function (uidvalidity) { | ||
| self.dbg('new uidvalidity : %s', uidvalidity); | ||
| }); | ||
| self.imap.once('ready', function () { | ||
| self.emit('connected'); | ||
| self.imap.openBox(self.options.box, false, function (err, box) { | ||
| scan(callback) { | ||
| const self = this, search = self.options.search || ['UNSEEN']; | ||
| self.dbg('scanning %s with filter `%s`.', self.options.box, search); | ||
| self.imap.search(search, function (err, searchResults) { | ||
| if (err) { | ||
| self.dbg('unable to open box : %s', err); | ||
| self.emit('error', err); | ||
| self.emit(NOTIFIER_EVENT_ERROR, err); | ||
| callback(); | ||
| return; | ||
| } | ||
| if (!searchResults || searchResults.length === 0) { | ||
| self.dbg('no new mail in %s', self.options.box); | ||
| callback(); | ||
| return; | ||
| } | ||
|
|
||
| q.push({name: 'scan initial'}, function(err) { | ||
| self.dbg('finished processing scan initial'); | ||
| }); | ||
|
|
||
| self.imap.on('mail', function (id) { | ||
| self.dbg('mail event : %s', id); | ||
| q.push({name: 'scan', id : id}, function(err) { | ||
| self.dbg('finished processing scan '+id); | ||
| }); | ||
| self.dbg('found %d new messages', searchResults.length); | ||
| const fetch = self.imap.fetch(searchResults, { | ||
| markSeen: self.options.markSeen !== false, | ||
| bodies: '' | ||
| }); | ||
| }); | ||
| }); | ||
| self.imap.connect(); | ||
| return this; | ||
| }; | ||
|
|
||
| Notifier.prototype.scan = function (callback) { | ||
| var self = this, search = self.options.search || ['UNSEEN']; | ||
| self.dbg('scanning %s with filter `%s`.', self.options.box, search); | ||
| self.imap.search(search, function (err, seachResults) { | ||
| if (err) { | ||
| self.emit('error', err); | ||
| callback(); | ||
| return; | ||
| } | ||
| if (!seachResults || seachResults.length === 0) { | ||
| self.dbg('no new mail in %s', self.options.box); | ||
| callback(); | ||
| return; | ||
| } | ||
| self.dbg('found %d new messages', seachResults.length); | ||
| var fetch = self.imap.fetch(seachResults, { | ||
| markSeen: self.options.markSeen !== false, | ||
| bodies: '' | ||
| }); | ||
| fetch.on('message', function (msg) { | ||
| var uid, flags; | ||
| msg.on('attributes', function(attrs) { | ||
| uid = attrs.uid; | ||
| flags = attrs.flags; | ||
| self.dbg("Message uid", attrs.uid); | ||
| }); | ||
| var mp = new MailParser(); | ||
| mp.once('end', function (mail) { | ||
| mail.uid = uid; | ||
| mail.flags = flags; | ||
| self.emit('mail', mail); | ||
| self.dbg('found mail '+mail.headers["message-id"]); | ||
| fetch.on(FETCH_EVENT_MESSAGE, function (msg) { | ||
| let uid, flags; | ||
| msg.on(MESSAGE_EVENT_ATTRIBUTES, function(attrs) { | ||
| uid = attrs.uid; | ||
| flags = attrs.flags; | ||
| self.dbg("Message uid", attrs.uid); | ||
| }); | ||
| msg.once(MESSAGE_EVENT_BODY, function (stream, info) { | ||
| stream.pipe(mp); | ||
| }); | ||
|
|
||
| const mp = new MailParser(); | ||
| mp.once(MESSAGE_EVENT_END, function (mail) { // this is technically event of mail parser, not message | ||
| mail.uid = uid; | ||
| mail.flags = flags; | ||
| self.emit(NOTIFIER_EVENT_MAIL, mail); | ||
| self.dbg('found mail '+mail.headers["message-id"]); | ||
| }); | ||
| }); | ||
| msg.once('body', function (stream, info) { | ||
| stream.pipe(mp); | ||
| fetch.once(FETCH_EVENT_END, function () { | ||
| self.dbg('Done fetching all messages!'); | ||
| callback(); | ||
| }); | ||
| fetch.once(FETCH_EVENT_ERROR, function (err) { | ||
| self.dbg('fetch error : ', err); | ||
| self.emit(NOTIFIER_EVENT_ERROR, err); | ||
| callback(); | ||
| }); | ||
| }); | ||
| fetch.once('end', function () { | ||
| self.dbg('Done fetching all messages!'); | ||
| callback(); | ||
| }); | ||
| fetch.once('error', function (err) { | ||
| self.dbg('fetch error : ', err); | ||
| self.emit('error', err); | ||
| callback(); | ||
| }); | ||
| }); | ||
| return this; | ||
| }; | ||
|
|
||
| Notifier.prototype.stop = function () { | ||
| var self = this; | ||
| self.dbg('imap.state before stopping: %s', this.imap.state); | ||
|
|
||
| if (this.imap.state !== 'disconnected') { | ||
| this.imap.end(); | ||
| return this; | ||
| } | ||
|
|
||
| self.dbg('notifier stopped'); | ||
| return this; | ||
| }; | ||
| stop() { | ||
| const self = this; | ||
| self.dbg('imap.state before stopping: %s', this.imap.state); | ||
|
|
||
| Notifier.prototype.dbg = dbg; | ||
| if (this.imap.state !== 'disconnected') { | ||
| this.imap.end(); | ||
| } | ||
|
|
||
| self.dbg('notifier stopped'); | ||
| return this; | ||
| } | ||
| } | ||
|
|
||
| module.exports = function (opts, customDbg) { | ||
| return new Notifier(opts, customDbg); | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2.7.1 is latest now
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that many of packes there was updated from time when I created this pull request.
You are invited add new pull request with updates.