NeoMutt  2025-12-11-694-ga89709
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 103 of file newsrc.c.

104{
105 for (int i = 0; i < NNTP_ACACHE_LEN; i++)
106 {
107 if (mdata->acache[i].path)
108 {
109 unlink(mdata->acache[i].path);
110 FREE(&mdata->acache[i].path);
111 }
112 }
113}
#define FREE(x)
Free memory and set the pointer to NULL.
Definition memory.h:68
#define NNTP_ACACHE_LEN
Definition lib.h:85
char * path
Cache path.
Definition lib.h:72
struct NntpAcache acache[NNTP_ACACHE_LEN]
Article cache.
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 646 of file newsrc.c.

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

572{
573 struct NntpAccountData *adata = data;
574 struct NntpMboxData *mdata = NULL;
575 char group[1024] = { 0 };
576 char desc[8192] = { 0 };
577 char mod = '\0';
578 anum_t first = 0, last = 0;
579
580 if (!adata || !line)
581 return 0;
582
583 /* These sscanf limits must match the sizes of the group and desc arrays */
584 if (sscanf(line, "%1023s " ANUM_FMT " " ANUM_FMT " %c %8191[^\n]", group,
585 &last, &first, &mod, desc) < 4)
586 {
587 mutt_debug(LL_DEBUG2, "Can't parse server line: %s\n", line);
588 return 0;
589 }
590
592 mdata->deleted = false;
593 mdata->first_message = first;
594 mdata->last_message = last;
595 mdata->allowed = (mod == 'y') || (mod == 'm');
596 mutt_str_replace(&mdata->desc, desc);
597 if (mdata->newsrc_ent || (mdata->last_cached != 0))
599 else if (mdata->last_message && (mdata->first_message <= mdata->last_message))
600 mdata->unread = mdata->last_message - mdata->first_message + 1;
601 else
602 mdata->unread = 0;
603 return 0;
604}
@ LL_DEBUG2
Log at debug level 2.
Definition logging2.h:46
char * mutt_str_replace(char **p, const char *s)
Replace one string with another.
Definition string.c:284
static struct NntpMboxData * mdata_find(struct NntpAccountData *adata, const char *group)
Find NntpMboxData for given newsgroup or add it.
Definition newsrc.c:73
void nntp_group_unread_stat(struct NntpMboxData *mdata)
Count number of unread articles using .newsrc data.
Definition newsrc.c:133
#define anum_t
Definition lib.h:63
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 1144 of file newsrc.c.

1145{
1146 struct NntpMboxData *mdata = m->mdata;
1147
1148 if (group)
1149 mdata = mutt_hash_find(mdata->adata->groups_hash, group);
1150
1151 if (!mdata)
1152 return;
1153
1154 for (unsigned int i = 0; i < mdata->newsrc_len; i++)
1155 {
1156 if ((anum >= mdata->newsrc_ent[i].first) && (anum <= mdata->newsrc_ent[i].last))
1157 {
1158 /* can't use mutt_set_flag() because mview_update() didn't get called yet */
1159 e->read = true;
1160 return;
1161 }
1162 }
1163
1164 /* article was not cached yet, it's new */
1165 if (anum > mdata->last_cached)
1166 return;
1167
1168 /* article isn't read but cached, it's old */
1169 const bool c_mark_old = cs_subset_bool(NeoMutt->sub, "mark_old");
1170 if (c_mark_old)
1171 e->old = true;
1172}
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:364
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:41
struct ConfigSubset * sub
Inherited config items.
Definition neomutt.h:49
anum_t last
Last article number in run.
Definition lib.h:81
struct NewsrcEntry * newsrc_ent
Newsrc entries.
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:339
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
Body cache.
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 2106 of file nntp.c.

2107{
2108 struct NntpMboxData tmp_mdata = { 0 };
2109 time_t now = 0;
2110 char buf[1024] = { 0 };
2111 char *msg = _("Checking for new newsgroups...");
2112 unsigned int i;
2113 int rc, update_active = false;
2114
2115 if (!adata || !adata->newgroups_time)
2116 return -1;
2117
2118 /* check subscribed newsgroups for new articles */
2119 const bool c_show_new_news = cs_subset_bool(NeoMutt->sub, "show_new_news");
2120 if (c_show_new_news)
2121 {
2122 mutt_message(_("Checking for new messages..."));
2123 for (i = 0; i < adata->groups_num; i++)
2124 {
2125 struct NntpMboxData *mdata = adata->groups_list[i];
2126
2127 if (mdata && mdata->subscribed)
2128 {
2129 rc = nntp_group_poll(mdata, true);
2130 if (rc < 0)
2131 return -1;
2132 if (rc > 0)
2133 update_active = true;
2134 }
2135 }
2136 }
2137 else if (adata->newgroups_time)
2138 {
2139 return 0;
2140 }
2141
2142 /* get list of new groups */
2143 mutt_message("%s", msg);
2144 if (nntp_date(adata, &now) < 0)
2145 return -1;
2146 tmp_mdata.adata = adata;
2147 if (m && m->mdata)
2148 tmp_mdata.group = ((struct NntpMboxData *) m->mdata)->group;
2149 else
2150 tmp_mdata.group = NULL;
2151 i = adata->groups_num;
2152 struct tm tm = mutt_date_gmtime(adata->newgroups_time);
2153 snprintf(buf, sizeof(buf), "NEWGROUPS %02d%02d%02d %02d%02d%02d GMT\r\n",
2154 tm.tm_year % 100, tm.tm_mon + 1, tm.tm_mday, tm.tm_hour, tm.tm_min, tm.tm_sec);
2155 rc = nntp_fetch_lines(&tmp_mdata, buf, sizeof(buf), msg, nntp_add_group, adata);
2156 if (rc)
2157 {
2158 if (rc > 0)
2159 {
2160 mutt_error("NEWGROUPS: %s", buf);
2161 }
2162 return -1;
2163 }
2164
2165 /* new groups found */
2166 rc = 0;
2167 if (adata->groups_num != i)
2168 {
2169 int groups_num = i;
2170
2171 adata->newgroups_time = now;
2172 for (; i < adata->groups_num; i++)
2173 {
2174 struct NntpMboxData *mdata = adata->groups_list[i];
2175 mdata->has_new_mail = true;
2176 }
2177
2178 /* loading descriptions */
2179 const bool c_nntp_load_description = cs_subset_bool(NeoMutt->sub, "nntp_load_description");
2180 if (c_nntp_load_description)
2181 {
2182 unsigned int count = 0;
2183 struct Progress *progress = progress_new(MUTT_PROGRESS_READ, adata->groups_num - i);
2184 progress_set_message(progress, _("Loading descriptions..."));
2185
2186 for (i = groups_num; i < adata->groups_num; i++)
2187 {
2188 struct NntpMboxData *mdata = adata->groups_list[i];
2189
2190 if (get_description(mdata, NULL, NULL) < 0)
2191 {
2192 progress_free(&progress);
2193 return -1;
2194 }
2195 progress_update(progress, ++count, -1);
2196 }
2197 progress_free(&progress);
2198 }
2199 update_active = true;
2200 rc = 1;
2201 }
2202 if (update_active)
2205 return rc;
2206}
#define mutt_error(...)
Definition logging2.h:94
#define mutt_message(...)
Definition logging2.h:93
struct tm mutt_date_gmtime(time_t t)
Converts calendar time to a broken-down time structure expressed in UTC timezone.
Definition date.c:928
#define _(a)
Definition message.h:28
void mutt_clear_error(void)
Clear the message line (bottom line of screen)
int nntp_add_group(char *line, void *data)
Parse newsgroup.
Definition newsrc.c:571
int nntp_active_save_cache(struct NntpAccountData *adata)
Save list of all newsgroups to cache.
Definition newsrc.c:646
static int nntp_date(struct NntpAccountData *adata, time_t *now)
Get date and time from server.
Definition nntp.c:1700
static int nntp_group_poll(struct NntpMboxData *mdata, bool update_stat)
Check newsgroup for new articles.
Definition nntp.c:1442
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:815
static int get_description(struct NntpMboxData *mdata, const char *wildmat, const char *msg)
Fetch newsgroups descriptions.
Definition nntp.c:937
@ MUTT_PROGRESS_READ
Progress tracks elements, according to $read_inc
Definition lib.h:84
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
bool has_new_mail
Has new articles.
Definition mdata.h:43
+ 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 const char *const c_header_cache_backend = cs_subset_string(NeoMutt->sub, "header_cache_backend");
815 const struct StoreOps *store_ops = store_get_backend_ops(c_header_cache_backend);
816 if (store_ops)
817 {
818 struct Buffer *file = buf_pool_get();
819 nntp_hcache_namer(store_ops, mdata->group, file);
820 cache_expand(file->data, file->dsize, &mdata->adata->conn->account, buf_string(file));
821 unlink(buf_string(file));
822 mdata->last_cached = 0;
823 mutt_debug(LL_DEBUG2, "%s\n", buf_string(file));
824 buf_pool_release(&file);
825 }
826#endif
827
828 if (!mdata->bcache)
829 {
830 mdata->bcache = mutt_bcache_open(&mdata->adata->conn->account, mdata->group);
831 }
832 if (mdata->bcache)
833 {
834 mutt_debug(LL_DEBUG2, "%s/*\n", mdata->group);
836 mutt_bcache_close(&mdata->bcache);
837 }
838}
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
const char * cs_subset_string(const struct ConfigSubset *sub, const char *name)
Get a string config item by name.
Definition helpers.c:291
static void nntp_hcache_namer(const struct StoreOps *store_ops, const char *path, struct Buffer *dest)
Compose hcache file names - Implements hcache_namer_t -.
Definition newsrc.c:687
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition pool.c:91
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition pool.c:111
const struct StoreOps * store_get_backend_ops(const char *str)
Get the API functions for an store backend.
Definition store.c:88
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
Last cached article.
Definition mdata.h:40
Definition lib.h:66
+ 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 133 of file newsrc.c.

134{
135 mdata->unread = 0;
136 if ((mdata->last_message == 0) ||
137 (mdata->first_message > mdata->last_message) || !mdata->newsrc_ent)
138 {
139 return;
140 }
141
142 mdata->unread = mdata->last_message - mdata->first_message + 1;
143 for (unsigned int i = 0; i < mdata->newsrc_len; i++)
144 {
145 anum_t first = mdata->newsrc_ent[i].first;
146 if (first < mdata->first_message)
147 first = mdata->first_message;
148 anum_t last = mdata->newsrc_ent[i].last;
149 if (last > mdata->last_message)
150 last = mdata->last_message;
151 if (first <= last)
152 mdata->unread -= last - first + 1;
153 }
154}
anum_t first
First article number in run.
Definition lib.h:80
anum_t last_message
Last article number.
Definition mdata.h:38
anum_t unread
Unread articles.
Definition mdata.h:41
unsigned int newsrc_len
Length of newsrc entry.
Definition mdata.h:46
anum_t first_message
First article number.
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:479
void account_to_url(struct ConnAccount *cac, struct Url *url)
Fill URL with info from account.
bool subscribed
Subscribed to this newsgroup.
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:423
#define U_PATH
Path is included in URL.
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:753
char * hcache_fetch_raw_str(struct HeaderCache *hc, const char *key, size_t keylen)
Fetch a string from the cache.
Definition hcache.c:663
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:738
+ 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 300 of file newsrc.c.

301{
302 if (!m)
303 return;
304
305 struct NntpMboxData *mdata = m->mdata;
306 anum_t last = 0, first = 1;
307 bool series;
308 unsigned int entries;
309
310 const enum EmailSortType c_sort = cs_subset_sort(NeoMutt->sub, "sort");
311 if (c_sort != EMAIL_SORT_UNSORTED)
312 {
315 }
316
317 entries = mdata->newsrc_len;
318 if (!entries)
319 {
320 entries = 5;
321 mdata->newsrc_ent = MUTT_MEM_CALLOC(entries, struct NewsrcEntry);
322 }
323
324 /* Set up to fake initial sequence from 1 to the article before the
325 * first article in our list */
326 mdata->newsrc_len = 0;
327 series = true;
328 for (int i = 0; i < m->msg_count; i++)
329 {
330 struct Email *e = m->emails[i];
331 if (!e)
332 break;
333
334 /* search for first unread */
335 if (series)
336 {
337 /* We don't actually check sequential order, since we mark
338 * "missing" entries as read/deleted */
339 last = nntp_edata_get(e)->article_num;
340 if ((last >= mdata->first_message) && !e->deleted && !e->read)
341 {
342 if (mdata->newsrc_len >= entries)
343 {
344 entries *= 2;
345 MUTT_MEM_REALLOC(&mdata->newsrc_ent, entries, struct NewsrcEntry);
346 }
347 mdata->newsrc_ent[mdata->newsrc_len].first = first;
348 mdata->newsrc_ent[mdata->newsrc_len].last = last - 1;
349 mdata->newsrc_len++;
350 series = false;
351 }
352 }
353 else
354 {
355 /* search for first read */
356 if (e->deleted || e->read)
357 {
358 first = last + 1;
359 series = true;
360 }
361 last = nntp_edata_get(e)->article_num;
362 }
363 }
364
365 if (series && (first <= mdata->last_loaded))
366 {
367 if (mdata->newsrc_len >= entries)
368 {
369 entries++;
370 MUTT_MEM_REALLOC(&mdata->newsrc_ent, entries, struct NewsrcEntry);
371 }
372 mdata->newsrc_ent[mdata->newsrc_len].first = first;
373 mdata->newsrc_ent[mdata->newsrc_len].last = mdata->last_loaded;
374 mdata->newsrc_len++;
375 }
376 MUTT_MEM_REALLOC(&mdata->newsrc_ent, mdata->newsrc_len, struct NewsrcEntry);
377
378 if (c_sort != EMAIL_SORT_UNSORTED)
379 {
380 cs_subset_str_native_set(NeoMutt->sub, "sort", c_sort, NULL);
382 }
383}
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:232
@ NT_MAILBOX_RESORT
Email list needs resorting.
Definition mailbox.h:180
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:87
struct Email ** emails
Array of Emails.
Definition mailbox.h:95
An entry in a .newsrc (subscribed newsgroups)
Definition lib.h:79
anum_t article_num
NNTP article number.
Definition edata.h:36
anum_t last_loaded
Last loaded article.
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:303
+ 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 1767 of file nntp.c.

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