NeoMutt  2025-09-05-7-geaa2bd
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
private.h File Reference

Usenet network mailbox type; talk to an NNTP server. More...

#include <stdbool.h>
#include <stdint.h>
#include "lib.h"
+ Include dependency graph for private.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define NNTP_PORT   119
 
#define NNTP_SSL_PORT   563
 

Enumerations

enum  NntpStatus { NNTP_NONE = 0 , NNTP_OK , NNTP_BYE }
 NNTP server return values. More...
 

Functions

void nntp_acache_free (struct NntpMboxData *mdata)
 Remove all temporarily cache files.
 
int nntp_active_save_cache (struct NntpAccountData *adata)
 Save list of all newsgroups to cache.
 
int nntp_add_group (char *line, void *data)
 Parse newsgroup.
 
void nntp_article_status (struct Mailbox *m, struct Email *e, char *group, anum_t anum)
 Get status of articles from .newsrc.
 
void nntp_bcache_update (struct NntpMboxData *mdata)
 Remove stale cached messages.
 
int nntp_check_new_groups (struct Mailbox *m, struct NntpAccountData *adata)
 Check for new groups/articles in subscribed groups.
 
void nntp_delete_group_cache (struct NntpMboxData *mdata)
 Remove hcache and bcache of newsgroup.
 
void nntp_group_unread_stat (struct NntpMboxData *mdata)
 Count number of unread articles using .newsrc data.
 
void nntp_hash_destructor_t (int type, void *obj, intptr_t data)
 
void nntp_hashelem_free (int type, void *obj, intptr_t data)
 Free our hash table data - Implements hash_hdata_free_t -.
 
struct HeaderCachenntp_hcache_open (struct NntpMboxData *mdata)
 Open newsgroup hcache.
 
void nntp_hcache_update (struct NntpMboxData *mdata, struct HeaderCache *hc)
 Remove stale cached headers.
 
void nntp_newsrc_gen_entries (struct Mailbox *m)
 Generate array of .newsrc entries.
 
int nntp_open_connection (struct NntpAccountData *adata)
 Connect to server, authenticate and get capabilities.
 

Detailed Description

Usenet network mailbox type; talk to an NNTP server.

Authors
  • Richard Russon

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file private.h.

Macro Definition Documentation

◆ NNTP_PORT

#define NNTP_PORT   119

Definition at line 36 of file private.h.

◆ NNTP_SSL_PORT

#define NNTP_SSL_PORT   563

Definition at line 37 of file private.h.

Enumeration Type Documentation

◆ NntpStatus

enum NntpStatus

NNTP server return values.

Enumerator
NNTP_NONE 

No connection to server.

NNTP_OK 

Connected to server.

NNTP_BYE 

Disconnected from server.

Definition at line 42 of file private.h.

43{
44 NNTP_NONE = 0,
45 NNTP_OK,
46 NNTP_BYE,
47};
@ NNTP_NONE
No connection to server.
Definition: private.h:44
@ NNTP_BYE
Disconnected from server.
Definition: private.h:46
@ NNTP_OK
Connected to server.
Definition: private.h:45

Function Documentation

◆ nntp_acache_free()

void nntp_acache_free ( struct NntpMboxData mdata)

Remove all temporarily cache files.

Parameters
mdataNNTP Mailbox data

Definition at line 104 of file newsrc.c.

105{
106 for (int i = 0; i < NNTP_ACACHE_LEN; i++)
107 {
108 if (mdata->acache[i].path)
109 {
110 unlink(mdata->acache[i].path);
111 FREE(&mdata->acache[i].path);
112 }
113 }
114}
#define FREE(x)
Definition: memory.h:62
#define NNTP_ACACHE_LEN
Definition: lib.h:83
char * path
Cache path.
Definition: lib.h:70
struct NntpAcache acache[NNTP_ACACHE_LEN]
Definition: mdata.h:49
+ Here is the caller graph for this function:

◆ nntp_active_save_cache()

int nntp_active_save_cache ( struct NntpAccountData adata)

Save list of all newsgroups to cache.

Parameters
adataNNTP server
Return values
0Success
-1Failure

Definition at line 647 of file newsrc.c.

648{
649 if (!adata->cacheable)
650 return 0;
651
652 size_t buflen = 10240;
653 char *buf = MUTT_MEM_CALLOC(buflen, char);
654 snprintf(buf, buflen, "%lu\n", (unsigned long) adata->newgroups_time);
655 size_t off = strlen(buf);
656
657 for (unsigned int i = 0; i < adata->groups_num; i++)
658 {
659 struct NntpMboxData *mdata = adata->groups_list[i];
660
661 if (!mdata || mdata->deleted)
662 continue;
663
664 if ((off + strlen(mdata->group) + (mdata->desc ? strlen(mdata->desc) : 0) + 50) > buflen)
665 {
666 buflen *= 2;
667 MUTT_MEM_REALLOC(&buf, buflen, char);
668 }
669 snprintf(buf + off, buflen - off, "%s " ANUM_FMT " " ANUM_FMT " %c%s%s\n",
670 mdata->group, mdata->last_message, mdata->first_message,
671 mdata->allowed ? 'y' : 'n', mdata->desc ? " " : "",
672 mdata->desc ? mdata->desc : "");
673 off += strlen(buf + off);
674 }
675
676 char file[PATH_MAX] = { 0 };
677 cache_expand(file, sizeof(file), &adata->conn->account, ".active");
678 mutt_debug(LL_DEBUG1, "Updating %s\n", file);
679 int rc = update_file(file, buf);
680 FREE(&buf);
681 return rc;
682}
#define mutt_debug(LEVEL,...)
Definition: logging2.h:90
@ LL_DEBUG1
Log at debug level 1.
Definition: logging2.h:44
#define MUTT_MEM_CALLOC(n, type)
Definition: memory.h:47
#define MUTT_MEM_REALLOC(pptr, n, type)
Definition: memory.h:50
#define PATH_MAX
Definition: mutt.h:42
static int update_file(char *filename, char *buf)
Update file with new contents.
Definition: newsrc.c:393
static void cache_expand(char *dst, size_t dstlen, struct ConnAccount *cac, const char *src)
Make fully qualified cache file name.
Definition: newsrc.c:524
#define ANUM_FMT
Definition: lib.h:62
struct ConnAccount account
Account details: username, password, etc.
Definition: connection.h:49
void * mdata
Driver specific data.
Definition: mailbox.h:132
time_t newgroups_time
Definition: adata.h:56
struct NntpMboxData ** groups_list
Definition: adata.h:60
struct Connection * conn
Connection to NNTP Server.
Definition: adata.h:62
unsigned int groups_num
Definition: adata.h:58
bool cacheable
Definition: adata.h:48
NNTP-specific Mailbox data -.
Definition: mdata.h:34
struct NntpAccountData * adata
Definition: mdata.h:48
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ nntp_add_group()

int nntp_add_group ( char *  line,
void *  data 
)

Parse newsgroup.

Parameters
lineString to parse
dataNNTP data
Return values
0Always

Definition at line 572 of file newsrc.c.

573{
574 struct NntpAccountData *adata = data;
575 struct NntpMboxData *mdata = NULL;
576 char group[1024] = { 0 };
577 char desc[8192] = { 0 };
578 char mod = '\0';
579 anum_t first = 0, last = 0;
580
581 if (!adata || !line)
582 return 0;
583
584 /* These sscanf limits must match the sizes of the group and desc arrays */
585 if (sscanf(line, "%1023s " ANUM_FMT " " ANUM_FMT " %c %8191[^\n]", group,
586 &last, &first, &mod, desc) < 4)
587 {
588 mutt_debug(LL_DEBUG2, "Can't parse server line: %s\n", line);
589 return 0;
590 }
591
593 mdata->deleted = false;
594 mdata->first_message = first;
595 mdata->last_message = last;
596 mdata->allowed = (mod == 'y') || (mod == 'm');
597 mutt_str_replace(&mdata->desc, desc);
598 if (mdata->newsrc_ent || (mdata->last_cached != 0))
600 else if (mdata->last_message && (mdata->first_message <= mdata->last_message))
601 mdata->unread = mdata->last_message - mdata->first_message + 1;
602 else
603 mdata->unread = 0;
604 return 0;
605}
@ LL_DEBUG2
Log at debug level 2.
Definition: logging2.h:45
char * mutt_str_replace(char **p, const char *s)
Replace one string with another.
Definition: string.c:281
static struct NntpMboxData * mdata_find(struct NntpAccountData *adata, const char *group)
Find NntpMboxData for given newsgroup or add it.
Definition: newsrc.c:74
void nntp_group_unread_stat(struct NntpMboxData *mdata)
Count number of unread articles using .newsrc data.
Definition: newsrc.c:134
#define anum_t
Definition: lib.h:61
void * adata
Private data (for Mailbox backends)
Definition: account.h:42
NNTP-specific Account data -.
Definition: adata.h:36
char * group
Name of newsgroup.
Definition: mdata.h:35
char * desc
Description of newsgroup.
Definition: mdata.h:36
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ nntp_article_status()

void nntp_article_status ( struct Mailbox m,
struct Email e,
char *  group,
anum_t  anum 
)

Get status of articles from .newsrc.

Parameters
mMailbox
eEmail
groupNewsgroup
anumArticle number

Full status flags are not supported by nntp, but we can fake some of them: Read = a read message number is in the .newsrc New = not read and not cached Old = not read but cached

Definition at line 1138 of file newsrc.c.

1139{
1140 struct NntpMboxData *mdata = m->mdata;
1141
1142 if (group)
1143 mdata = mutt_hash_find(mdata->adata->groups_hash, group);
1144
1145 if (!mdata)
1146 return;
1147
1148 for (unsigned int i = 0; i < mdata->newsrc_len; i++)
1149 {
1150 if ((anum >= mdata->newsrc_ent[i].first) && (anum <= mdata->newsrc_ent[i].last))
1151 {
1152 /* can't use mutt_set_flag() because mview_update() didn't get called yet */
1153 e->read = true;
1154 return;
1155 }
1156 }
1157
1158 /* article was not cached yet, it's new */
1159 if (anum > mdata->last_cached)
1160 return;
1161
1162 /* article isn't read but cached, it's old */
1163 const bool c_mark_old = cs_subset_bool(NeoMutt->sub, "mark_old");
1164 if (c_mark_old)
1165 e->old = true;
1166}
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:47
void * mutt_hash_find(const struct HashTable *table, const char *strkey)
Find the HashElem data in a Hash Table element using a key.
Definition: hash.c:362
bool read
Email is read.
Definition: email.h:50
bool old
Email is seen, but unread.
Definition: email.h:49
Container for Accounts, Notifications.
Definition: neomutt.h:43
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:47
anum_t last
Last article number in run.
Definition: lib.h:79
struct NewsrcEntry * newsrc_ent
Definition: mdata.h:47
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ nntp_bcache_update()

void nntp_bcache_update ( struct NntpMboxData mdata)

Remove stale cached messages.

Parameters
mdataNNTP Mailbox data

Definition at line 799 of file newsrc.c.

800{
802}
int mutt_bcache_list(struct BodyCache *bcache, bcache_list_t want_id, void *data)
Find matching entries in the Body Cache.
Definition: bcache.c:334
static int nntp_bcache_delete(const char *id, struct BodyCache *bcache, void *data)
Delete an entry from the message cache - Implements bcache_list_t -.
Definition: newsrc.c:779
struct BodyCache * bcache
Definition: mdata.h:50
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ nntp_check_new_groups()

int nntp_check_new_groups ( struct Mailbox m,
struct NntpAccountData adata 
)

Check for new groups/articles in subscribed groups.

Parameters
mMailbox
adataNNTP server
Return values
1New groups found
0No new groups
-1Error

Definition at line 2104 of file nntp.c.

2105{
2106 struct NntpMboxData tmp_mdata = { 0 };
2107 time_t now = 0;
2108 char buf[1024] = { 0 };
2109 char *msg = _("Checking for new newsgroups...");
2110 unsigned int i;
2111 int rc, update_active = false;
2112
2113 if (!adata || !adata->newgroups_time)
2114 return -1;
2115
2116 /* check subscribed newsgroups for new articles */
2117 const bool c_show_new_news = cs_subset_bool(NeoMutt->sub, "show_new_news");
2118 if (c_show_new_news)
2119 {
2120 mutt_message(_("Checking for new messages..."));
2121 for (i = 0; i < adata->groups_num; i++)
2122 {
2123 struct NntpMboxData *mdata = adata->groups_list[i];
2124
2125 if (mdata && mdata->subscribed)
2126 {
2127 rc = nntp_group_poll(mdata, true);
2128 if (rc < 0)
2129 return -1;
2130 if (rc > 0)
2131 update_active = true;
2132 }
2133 }
2134 }
2135 else if (adata->newgroups_time)
2136 {
2137 return 0;
2138 }
2139
2140 /* get list of new groups */
2141 mutt_message("%s", msg);
2142 if (nntp_date(adata, &now) < 0)
2143 return -1;
2144 tmp_mdata.adata = adata;
2145 if (m && m->mdata)
2146 tmp_mdata.group = ((struct NntpMboxData *) m->mdata)->group;
2147 else
2148 tmp_mdata.group = NULL;
2149 i = adata->groups_num;
2150 struct tm tm = mutt_date_gmtime(adata->newgroups_time);
2151 snprintf(buf, sizeof(buf), "NEWGROUPS %02d%02d%02d %02d%02d%02d GMT\r\n",
2152 tm.tm_year % 100, tm.tm_mon + 1, tm.tm_mday, tm.tm_hour, tm.tm_min, tm.tm_sec);
2153 rc = nntp_fetch_lines(&tmp_mdata, buf, sizeof(buf), msg, nntp_add_group, adata);
2154 if (rc)
2155 {
2156 if (rc > 0)
2157 {
2158 mutt_error("NEWGROUPS: %s", buf);
2159 }
2160 return -1;
2161 }
2162
2163 /* new groups found */
2164 rc = 0;
2165 if (adata->groups_num != i)
2166 {
2167 int groups_num = i;
2168
2169 adata->newgroups_time = now;
2170 for (; i < adata->groups_num; i++)
2171 {
2172 struct NntpMboxData *mdata = adata->groups_list[i];
2173 mdata->has_new_mail = true;
2174 }
2175
2176 /* loading descriptions */
2177 const bool c_nntp_load_description = cs_subset_bool(NeoMutt->sub, "nntp_load_description");
2178 if (c_nntp_load_description)
2179 {
2180 unsigned int count = 0;
2181 struct Progress *progress = progress_new(MUTT_PROGRESS_READ, adata->groups_num - i);
2182 progress_set_message(progress, _("Loading descriptions..."));
2183
2184 for (i = groups_num; i < adata->groups_num; i++)
2185 {
2186 struct NntpMboxData *mdata = adata->groups_list[i];
2187
2188 if (get_description(mdata, NULL, NULL) < 0)
2189 {
2190 progress_free(&progress);
2191 return -1;
2192 }
2193 progress_update(progress, ++count, -1);
2194 }
2195 progress_free(&progress);
2196 }
2197 update_active = true;
2198 rc = 1;
2199 }
2200 if (update_active)
2203 return rc;
2204}
#define mutt_error(...)
Definition: logging2.h:93
#define mutt_message(...)
Definition: logging2.h:92
struct tm mutt_date_gmtime(time_t t)
Converts calendar time to a broken-down time structure expressed in UTC timezone.
Definition: date.c:927
#define _(a)
Definition: message.h:28
void mutt_clear_error(void)
Clear the message line (bottom line of screen)
Definition: mutt_logging.c:74
int nntp_add_group(char *line, void *data)
Parse newsgroup.
Definition: newsrc.c:572
int nntp_active_save_cache(struct NntpAccountData *adata)
Save list of all newsgroups to cache.
Definition: newsrc.c:647
static int nntp_date(struct NntpAccountData *adata, time_t *now)
Get date and time from server.
Definition: nntp.c:1698
static int nntp_group_poll(struct NntpMboxData *mdata, bool update_stat)
Check newsgroup for new articles.
Definition: nntp.c:1440
static int nntp_fetch_lines(struct NntpMboxData *mdata, char *query, size_t qlen, const char *msg, int(*func)(char *, void *), void *data)
Read lines, calling a callback function for each.
Definition: nntp.c:813
static int get_description(struct NntpMboxData *mdata, const char *wildmat, const char *msg)
Fetch newsgroups descriptions.
Definition: nntp.c:935
@ MUTT_PROGRESS_READ
Progress tracks elements, according to $read_inc
Definition: lib.h:83
struct Progress * progress_new(enum ProgressType type, size_t size)
Create a new Progress Bar.
Definition: progress.c:139
void progress_free(struct Progress **ptr)
Free a Progress Bar.
Definition: progress.c:110
void progress_set_message(struct Progress *progress, const char *fmt,...) __attribute__((__format__(__printf__
bool progress_update(struct Progress *progress, size_t pos, int percent)
Update the state of the progress bar.
Definition: progress.c:80
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ nntp_delete_group_cache()

void nntp_delete_group_cache ( struct NntpMboxData mdata)

Remove hcache and bcache of newsgroup.

Parameters
mdataNNTP Mailbox data

Definition at line 808 of file newsrc.c.

809{
810 if (!mdata || !mdata->adata || !mdata->adata->cacheable)
811 return;
812
813#ifdef USE_HCACHE
814 struct Buffer *file = buf_pool_get();
815 nntp_hcache_namer(mdata->group, file);
816 cache_expand(file->data, file->dsize, &mdata->adata->conn->account, buf_string(file));
817 unlink(buf_string(file));
818 mdata->last_cached = 0;
819 mutt_debug(LL_DEBUG2, "%s\n", buf_string(file));
820 buf_pool_release(&file);
821#endif
822
823 if (!mdata->bcache)
824 {
825 mdata->bcache = mutt_bcache_open(&mdata->adata->conn->account, mdata->group);
826 }
827 if (mdata->bcache)
828 {
829 mutt_debug(LL_DEBUG2, "%s/*\n", mdata->group);
831 mutt_bcache_close(&mdata->bcache);
832 }
833}
struct BodyCache * mutt_bcache_open(struct ConnAccount *account, const char *mailbox)
Open an Email-Body Cache.
Definition: bcache.c:146
void mutt_bcache_close(struct BodyCache **ptr)
Close an Email-Body Cache.
Definition: bcache.c:167
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:96
static void nntp_hcache_namer(const char *path, struct Buffer *dest)
Compose hcache file names - Implements hcache_namer_t -.
Definition: newsrc.c:688
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:82
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition: pool.c:96
String manipulation buffer.
Definition: buffer.h:36
size_t dsize
Length of data.
Definition: buffer.h:39
char * data
Pointer to data.
Definition: buffer.h:37
anum_t last_cached
Definition: mdata.h:40
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ nntp_group_unread_stat()

void nntp_group_unread_stat ( struct NntpMboxData mdata)

Count number of unread articles using .newsrc data.

Parameters
mdataNNTP Mailbox data

Definition at line 134 of file newsrc.c.

135{
136 mdata->unread = 0;
137 if ((mdata->last_message == 0) ||
138 (mdata->first_message > mdata->last_message) || !mdata->newsrc_ent)
139 {
140 return;
141 }
142
143 mdata->unread = mdata->last_message - mdata->first_message + 1;
144 for (unsigned int i = 0; i < mdata->newsrc_len; i++)
145 {
146 anum_t first = mdata->newsrc_ent[i].first;
147 if (first < mdata->first_message)
148 first = mdata->first_message;
149 anum_t last = mdata->newsrc_ent[i].last;
150 if (last > mdata->last_message)
151 last = mdata->last_message;
152 if (first <= last)
153 mdata->unread -= last - first + 1;
154 }
155}
anum_t first
First article number in run.
Definition: lib.h:78
anum_t last_message
Definition: mdata.h:38
anum_t unread
Definition: mdata.h:41
unsigned int newsrc_len
Definition: mdata.h:46
anum_t first_message
Definition: mdata.h:37
+ Here is the caller graph for this function:

◆ nntp_hash_destructor_t()

void nntp_hash_destructor_t ( int  type,
void *  obj,
intptr_t  data 
)

◆ nntp_hcache_open()

struct HeaderCache * nntp_hcache_open ( struct NntpMboxData mdata)

Open newsgroup hcache.

Parameters
mdataNNTP Mailbox data
Return values
ptrHeader cache
NULLError

Definition at line 707 of file newsrc.c.

708{
709 struct Url url = { 0 };
710 char file[PATH_MAX] = { 0 };
711
712 const bool c_save_unsubscribed = cs_subset_bool(NeoMutt->sub, "save_unsubscribed");
713 if (!mdata->adata || !mdata->adata->cacheable || !mdata->adata->conn || !mdata->group ||
714 !(mdata->newsrc_ent || mdata->subscribed || c_save_unsubscribed))
715 {
716 return NULL;
717 }
718
719 account_to_url(&mdata->adata->conn->account, &url);
720 url.path = mdata->group;
721 url_tostring(&url, file, sizeof(file), U_PATH);
722 const char *const c_news_cache_dir = cs_subset_path(NeoMutt->sub, "news_cache_dir");
723 return hcache_open(c_news_cache_dir, file, nntp_hcache_namer, true);
724}
const char * cs_subset_path(const struct ConfigSubset *sub, const char *name)
Get a path config item by name.
Definition: helpers.c:168
struct HeaderCache * hcache_open(const char *path, const char *folder, hcache_namer_t namer, bool create)
Multiplexor for StoreOps::open.
Definition: hcache.c:471
void account_to_url(struct ConnAccount *cac, struct Url *url)
Fill URL with info from account.
Definition: mutt_account.c:80
bool subscribed
Definition: mdata.h:42
A parsed URL proto://user:password@host:port/path?a=1&b=2
Definition: url.h:69
char * path
Path.
Definition: url.h:75
int url_tostring(const struct Url *url, char *dest, size_t len, uint8_t flags)
Output the URL string for a given Url object.
Definition: url.c:422
#define U_PATH
Definition: url.h:50
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ nntp_hcache_update()

void nntp_hcache_update ( struct NntpMboxData mdata,
struct HeaderCache hc 
)

Remove stale cached headers.

Parameters
mdataNNTP Mailbox data
hcHeader cache

Definition at line 731 of file newsrc.c.

732{
733 if (!hc)
734 return;
735
736 char buf[32] = { 0 };
737 bool old = false;
738 anum_t first = 0, last = 0;
739
740 /* fetch previous values of first and last */
741 char *hdata = hcache_fetch_raw_str(hc, "index", 5);
742 if (hdata)
743 {
744 mutt_debug(LL_DEBUG2, "hcache_fetch_email index: %s\n", hdata);
745 if (sscanf(hdata, ANUM_FMT " " ANUM_FMT, &first, &last) == 2)
746 {
747 old = true;
748 mdata->last_cached = last;
749
750 /* clean removed headers from cache */
751 for (anum_t current = first; current <= last; current++)
752 {
753 if ((current >= mdata->first_message) && (current <= mdata->last_message))
754 continue;
755
756 snprintf(buf, sizeof(buf), ANUM_FMT, current);
757 mutt_debug(LL_DEBUG2, "hcache_delete_email %s\n", buf);
758 hcache_delete_email(hc, buf, strlen(buf));
759 }
760 }
761 FREE(&hdata);
762 }
763
764 /* store current values of first and last */
765 if (!old || (mdata->first_message != first) || (mdata->last_message != last))
766 {
767 snprintf(buf, sizeof(buf), ANUM_FMT " " ANUM_FMT, mdata->first_message,
768 mdata->last_message);
769 mutt_debug(LL_DEBUG2, "hcache_store_email index: %s\n", buf);
770 hcache_store_raw(hc, "index", 5, buf, strlen(buf) + 1);
771 }
772}
int hcache_delete_email(struct HeaderCache *hc, const char *key, size_t keylen)
Multiplexor for StoreOps::delete_record.
Definition: hcache.c:739
char * hcache_fetch_raw_str(struct HeaderCache *hc, const char *key, size_t keylen)
Fetch a string from the cache.
Definition: hcache.c:652
int hcache_store_raw(struct HeaderCache *hc, const char *key, size_t keylen, void *data, size_t dlen)
Store a key / data pair.
Definition: hcache.c:724
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ nntp_newsrc_gen_entries()

void nntp_newsrc_gen_entries ( struct Mailbox m)

Generate array of .newsrc entries.

Parameters
mMailbox

Definition at line 301 of file newsrc.c.

302{
303 if (!m)
304 return;
305
306 struct NntpMboxData *mdata = m->mdata;
307 anum_t last = 0, first = 1;
308 bool series;
309 unsigned int entries;
310
311 const enum EmailSortType c_sort = cs_subset_sort(NeoMutt->sub, "sort");
312 if (c_sort != EMAIL_SORT_UNSORTED)
313 {
316 }
317
318 entries = mdata->newsrc_len;
319 if (!entries)
320 {
321 entries = 5;
322 mdata->newsrc_ent = MUTT_MEM_CALLOC(entries, struct NewsrcEntry);
323 }
324
325 /* Set up to fake initial sequence from 1 to the article before the
326 * first article in our list */
327 mdata->newsrc_len = 0;
328 series = true;
329 for (int i = 0; i < m->msg_count; i++)
330 {
331 struct Email *e = m->emails[i];
332 if (!e)
333 break;
334
335 /* search for first unread */
336 if (series)
337 {
338 /* We don't actually check sequential order, since we mark
339 * "missing" entries as read/deleted */
340 last = nntp_edata_get(e)->article_num;
341 if ((last >= mdata->first_message) && !e->deleted && !e->read)
342 {
343 if (mdata->newsrc_len >= entries)
344 {
345 entries *= 2;
346 MUTT_MEM_REALLOC(&mdata->newsrc_ent, entries, struct NewsrcEntry);
347 }
348 mdata->newsrc_ent[mdata->newsrc_len].first = first;
349 mdata->newsrc_ent[mdata->newsrc_len].last = last - 1;
350 mdata->newsrc_len++;
351 series = false;
352 }
353 }
354 else
355 {
356 /* search for first read */
357 if (e->deleted || e->read)
358 {
359 first = last + 1;
360 series = true;
361 }
362 last = nntp_edata_get(e)->article_num;
363 }
364 }
365
366 if (series && (first <= mdata->last_loaded))
367 {
368 if (mdata->newsrc_len >= entries)
369 {
370 entries++;
371 MUTT_MEM_REALLOC(&mdata->newsrc_ent, entries, struct NewsrcEntry);
372 }
373 mdata->newsrc_ent[mdata->newsrc_len].first = first;
374 mdata->newsrc_ent[mdata->newsrc_len].last = mdata->last_loaded;
375 mdata->newsrc_len++;
376 }
377 MUTT_MEM_REALLOC(&mdata->newsrc_ent, mdata->newsrc_len, struct NewsrcEntry);
378
379 if (c_sort != EMAIL_SORT_UNSORTED)
380 {
381 cs_subset_str_native_set(NeoMutt->sub, "sort", c_sort, NULL);
383 }
384}
short cs_subset_sort(const struct ConfigSubset *sub, const char *name)
Get a sort config item by name.
Definition: helpers.c:266
void mailbox_changed(struct Mailbox *m, enum NotifyMailbox action)
Notify observers of a change to a Mailbox.
Definition: mailbox.c:233
@ NT_MAILBOX_RESORT
Email list needs resorting.
Definition: mailbox.h:190
EmailSortType
Methods for sorting Emails.
Definition: sort.h:53
@ EMAIL_SORT_UNSORTED
Sort by the order the messages appear in the mailbox.
Definition: sort.h:64
struct NntpEmailData * nntp_edata_get(struct Email *e)
Get the private data for this Email.
Definition: edata.c:60
The envelope/body of an email.
Definition: email.h:39
bool deleted
Email is deleted.
Definition: email.h:78
int msg_count
Total number of messages.
Definition: mailbox.h:88
struct Email ** emails
Array of Emails.
Definition: mailbox.h:96
An entry in a .newsrc (subscribed newsgroups)
Definition: lib.h:77
anum_t article_num
NNTP article number.
Definition: edata.h:36
anum_t last_loaded
Definition: mdata.h:39
int cs_subset_str_native_set(const struct ConfigSubset *sub, const char *name, intptr_t value, struct Buffer *err)
Natively set the value of a string config item.
Definition: subset.c:299
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ nntp_open_connection()

int nntp_open_connection ( struct NntpAccountData adata)

Connect to server, authenticate and get capabilities.

Parameters
adataNNTP server
Return values
0Success
-1Failure

Definition at line 1765 of file nntp.c.

1766{
1767 if (adata->status == NNTP_OK)
1768 return 0;
1769 if (adata->status == NNTP_BYE)
1770 return -1;
1771 adata->status = NNTP_NONE;
1772
1773 struct Connection *conn = adata->conn;
1774 if (mutt_socket_open(conn) < 0)
1775 return -1;
1776
1777 char buf[256] = { 0 };
1778 int cap;
1779 bool posting = false, auth = true;
1780 int rc = -1;
1781
1782 if (mutt_socket_readln(buf, sizeof(buf), conn) < 0)
1783 {
1784 nntp_connect_error(adata);
1785 goto done;
1786 }
1787
1788 if (mutt_str_startswith(buf, "200"))
1789 {
1790 posting = true;
1791 }
1792 else if (!mutt_str_startswith(buf, "201"))
1793 {
1794 mutt_socket_close(conn);
1796 mutt_error("%s", buf);
1797 goto done;
1798 }
1799
1800 /* get initial capabilities */
1801 cap = nntp_capabilities(adata);
1802 if (cap < 0)
1803 goto done;
1804
1805 /* tell news server to switch to mode reader if it isn't so */
1806 if (cap > 0)
1807 {
1808 if ((mutt_socket_send(conn, "MODE READER\r\n") < 0) ||
1809 (mutt_socket_readln(buf, sizeof(buf), conn) < 0))
1810 {
1811 nntp_connect_error(adata);
1812 goto done;
1813 }
1814
1815 if (mutt_str_startswith(buf, "200"))
1816 {
1817 posting = true;
1818 }
1819 else if (mutt_str_startswith(buf, "201"))
1820 {
1821 posting = false;
1822 }
1823 else if (adata->hasCAPABILITIES)
1824 {
1825 /* error if has capabilities, ignore result if no capabilities */
1826 mutt_socket_close(conn);
1827 mutt_error(_("Could not switch to reader mode"));
1828 goto done;
1829 }
1830
1831 /* recheck capabilities after MODE READER */
1832 if (adata->hasCAPABILITIES)
1833 {
1834 cap = nntp_capabilities(adata);
1835 if (cap < 0)
1836 goto done;
1837 }
1838 }
1839
1840 mutt_message(_("Connected to %s. %s"), conn->account.host,
1841 posting ? _("Posting is ok") : _("Posting is NOT ok"));
1842 mutt_sleep(1);
1843
1844#ifdef USE_SSL
1845 /* Attempt STARTTLS if available and desired. */
1846 const bool c_ssl_force_tls = cs_subset_bool(NeoMutt->sub, "ssl_force_tls");
1847 if ((adata->use_tls != 1) && (adata->hasSTARTTLS || c_ssl_force_tls))
1848 {
1849 if (adata->use_tls == 0)
1850 {
1851 adata->use_tls = c_ssl_force_tls ||
1852 (query_quadoption(_("Secure connection with TLS?"),
1853 NeoMutt->sub, "ssl_starttls") == MUTT_YES) ?
1854 2 :
1855 1;
1856 }
1857 if (adata->use_tls == 2)
1858 {
1859 if ((mutt_socket_send(conn, "STARTTLS\r\n") < 0) ||
1860 (mutt_socket_readln(buf, sizeof(buf), conn) < 0))
1861 {
1862 nntp_connect_error(adata);
1863 goto done;
1864 }
1865 // Clear any data after the STARTTLS acknowledgement
1866 mutt_socket_empty(conn);
1867 if (!mutt_str_startswith(buf, "382"))
1868 {
1869 adata->use_tls = 0;
1870 mutt_error("STARTTLS: %s", buf);
1871 }
1872 else if (mutt_ssl_starttls(conn))
1873 {
1874 adata->use_tls = 0;
1875 adata->status = NNTP_NONE;
1876 mutt_socket_close(adata->conn);
1877 mutt_error(_("Could not negotiate TLS connection"));
1878 goto done;
1879 }
1880 else
1881 {
1882 /* recheck capabilities after STARTTLS */
1883 cap = nntp_capabilities(adata);
1884 if (cap < 0)
1885 goto done;
1886 }
1887 }
1888 }
1889#endif
1890
1891 /* authentication required? */
1892 if (conn->account.flags & MUTT_ACCT_USER)
1893 {
1894 if (!conn->account.user[0])
1895 auth = false;
1896 }
1897 else
1898 {
1899 if ((mutt_socket_send(conn, "STAT\r\n") < 0) ||
1900 (mutt_socket_readln(buf, sizeof(buf), conn) < 0))
1901 {
1902 nntp_connect_error(adata);
1903 goto done;
1904 }
1905 if (!mutt_str_startswith(buf, "480"))
1906 auth = false;
1907 }
1908
1909 /* authenticate */
1910 if (auth && (nntp_auth(adata) < 0))
1911 goto done;
1912
1913 /* get final capabilities after authentication */
1914 if (adata->hasCAPABILITIES && (auth || (cap > 0)))
1915 {
1916 cap = nntp_capabilities(adata);
1917 if (cap < 0)
1918 goto done;
1919 if (cap > 0)
1920 {
1921 mutt_socket_close(conn);
1922 mutt_error(_("Could not switch to reader mode"));
1923 goto done;
1924 }
1925 }
1926
1927 /* attempt features */
1928 if (nntp_attempt_features(adata) < 0)
1929 goto done;
1930
1931 rc = 0;
1932 adata->status = NNTP_OK;
1933
1934done:
1935 return rc;
1936}
#define MUTT_ACCT_USER
User field has been set.
Definition: connaccount.h:44
int mutt_ssl_starttls(struct Connection *conn)
Negotiate TLS over an already opened connection.
Definition: gnutls.c:1149
void mutt_str_remove_trailing_ws(char *s)
Trim trailing whitespace from a string.
Definition: string.c:564
size_t mutt_str_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix.
Definition: string.c:231
void mutt_sleep(short s)
Sleep for a while.
Definition: muttlib.c:841
static int nntp_auth(struct NntpAccountData *adata)
Get login, password and authenticate.
Definition: nntp.c:451
static int nntp_capabilities(struct NntpAccountData *adata)
Get capabilities.
Definition: nntp.c:140
static int nntp_connect_error(struct NntpAccountData *adata)
Signal a failed connection.
Definition: nntp.c:126
static int nntp_attempt_features(struct NntpAccountData *adata)
Detect supported commands.
Definition: nntp.c:259
@ MUTT_YES
User answered 'Yes', or assume 'Yes'.
Definition: quad.h:39
enum QuadOption query_quadoption(const char *prompt, struct ConfigSubset *sub, const char *name)
Ask the user a quad-question.
Definition: question.c:378
int mutt_socket_close(struct Connection *conn)
Close a socket.
Definition: socket.c:100
void mutt_socket_empty(struct Connection *conn)
Clear out any queued data.
Definition: socket.c:306
int mutt_socket_open(struct Connection *conn)
Simple wrapper.
Definition: socket.c:76
#define mutt_socket_readln(buf, buflen, conn)
Definition: socket.h:56
#define mutt_socket_send(conn, buf)
Definition: socket.h:57
char user[128]
Username.
Definition: connaccount.h:56
char host[128]
Server to login to.
Definition: connaccount.h:54
MuttAccountFlags flags
Which fields are initialised, e.g. MUTT_ACCT_USER.
Definition: connaccount.h:60
unsigned int status
Definition: adata.h:47
bool hasCAPABILITIES
Server supports CAPABILITIES command.
Definition: adata.h:37
bool hasSTARTTLS
Server supports STARTTLS command.
Definition: adata.h:38
unsigned int use_tls
Definition: adata.h:46
+ Here is the call graph for this function:
+ Here is the caller graph for this function: