newsrc.c File Reference

Read/parse/write an NNTP config file of subscribed newsgroups. More...

#include "config.h"
#include <dirent.h>
#include <errno.h>
#include <inttypes.h>
#include <limits.h>
#include <stdbool.h>
#include <stdio.h>
#include <string.h>
#include <sys/stat.h>
#include <unistd.h>
#include "private.h"
#include "mutt/lib.h"
#include "config/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "conn/lib.h"
#include "mutt.h"
#include "lib.h"
#include "bcache/lib.h"
#include "adata.h"
#include "edata.h"
#include "format_flags.h"
#include "mdata.h"
#include "mutt_account.h"
#include "mutt_logging.h"
#include "mutt_socket.h"
#include "muttlib.h"
#include "protos.h"
#include "hcache/lib.h"

Include dependency graph for newsrc.c:

Go to the source code of this file.

Functions
static struct NntpMboxData *	mdata_find (struct NntpAccountData *adata, const char *group)
	Find NntpMboxData for given newsgroup or add it. More...
void	nntp_acache_free (struct NntpMboxData *mdata)
	Remove all temporarily cache files. More...
void	nntp_newsrc_close (struct NntpAccountData *adata)
	Unlock and close .newsrc file. More...
void	nntp_group_unread_stat (struct NntpMboxData *mdata)
	Count number of unread articles using .newsrc data. More...
int	nntp_newsrc_parse (struct NntpAccountData *adata)
	Parse .newsrc file. More...
void	nntp_newsrc_gen_entries (struct Mailbox *m)
	Generate array of .newsrc entries. More...
static int	update_file (char *filename, char *buf)
	Update file with new contents. More...
int	nntp_newsrc_update (struct NntpAccountData *adata)
	Update .newsrc file. More...
static void	cache_expand (char *dst, size_t dstlen, struct ConnAccount *cac, const char *src)
	Make fully qualified cache file name. More...
void	nntp_expand_path (char *buf, size_t buflen, struct ConnAccount *cac)
	Make fully qualified url from newsgroup name. More...
int	nntp_add_group (char *line, void *data)
	Parse newsgroup. More...
static int	active_get_cache (struct NntpAccountData *adata)
	Load list of all newsgroups from cache. More...
int	nntp_active_save_cache (struct NntpAccountData *adata)
	Save list of all newsgroups to cache. More...
static void	nntp_hcache_namer (const char *path, struct Buffer *dest)
	Compose hcache file names - Implements hcache_namer_t -. More...
struct HeaderCache *	nntp_hcache_open (struct NntpMboxData *mdata)
	Open newsgroup hcache. More...
void	nntp_hcache_update (struct NntpMboxData *mdata, struct HeaderCache *hc)
	Remove stale cached headers. More...
static int	nntp_bcache_delete (const char *id, struct BodyCache *bcache, void *data)
	Remove bcache file - Implements bcache_list_t -. More...
void	nntp_bcache_update (struct NntpMboxData *mdata)
	Remove stale cached messages. More...
void	nntp_delete_group_cache (struct NntpMboxData *mdata)
	Remove hcache and bcache of newsgroup. More...
void	nntp_clear_cache (struct NntpAccountData *adata)
	Clear the NNTP cache. More...
const char *	nntp_format_str (char *buf, size_t buflen, size_t col, int cols, char op, const char *src, const char *prec, const char *if_str, const char *else_str, intptr_t data, MuttFormatFlags flags)
	Expand the newsrc filename - Implements format_t -. More...
static const char *	nntp_get_field (enum ConnAccountField field, void *gf_data)
	Get connection login credentials - Implements ConnAccount::get_field() More...
struct NntpAccountData *	nntp_select_server (struct Mailbox *m, const char *server, bool leave_lock)
	Open a connection to an NNTP server. More...
void	nntp_article_status (struct Mailbox *m, struct Email *e, char *group, anum_t anum)
	Get status of articles from .newsrc. More...
struct NntpMboxData *	mutt_newsgroup_subscribe (struct NntpAccountData *adata, char *group)
	Subscribe newsgroup. More...
struct NntpMboxData *	mutt_newsgroup_unsubscribe (struct NntpAccountData *adata, char *group)
	Unsubscribe newsgroup. More...
struct NntpMboxData *	mutt_newsgroup_catchup (struct Mailbox *m, struct NntpAccountData *adata, char *group)
	Catchup newsgroup. More...
struct NntpMboxData *	mutt_newsgroup_uncatchup (struct Mailbox *m, struct NntpAccountData *adata, char *group)
	Uncatchup newsgroup. More...
void	nntp_mailbox (struct Mailbox *m, char *buf, size_t buflen)
	Get first newsgroup with new messages. More...

Detailed Description

Read/parse/write an NNTP config file of subscribed newsgroups.

Authors

• Brandon Long
• Andrej Gritsenko
• Vsevolod Volkov

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

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 newsrc.c.

Function Documentation

mdata_find()

static struct NntpMboxData * mdata_find ( struct NntpAccountData *  adata, const char *  group  )

static

Find NntpMboxData for given newsgroup or add it.

Parameters

adata	NNTP server
group	Newsgroup

Return values

ptr	NNTP data
NULL	Error

Definition at line 72 of file newsrc.c.

{
  struct NntpMboxData *mdata = mutt_hash_find(adata->groups_hash, group);
  if (mdata)
    return mdata;
 
  size_t len = strlen(group) + 1;
  /* create NntpMboxData structure and add it to hash */
  mdata = mutt_mem_calloc(1, sizeof(struct NntpMboxData) + len);
  mdata->group = (char *) mdata + sizeof(struct NntpMboxData);
  mutt_str_copy(mdata->group, group, len);
  mdata->adata = adata;
  mdata->deleted = true;
  mutt_hash_insert(adata->groups_hash, mdata->group, mdata);
 
  /* add NntpMboxData to list */
  if (adata->groups_num >= adata->groups_max)
  {
    adata->groups_max *= 2;
    mutt_mem_realloc(&adata->groups_list, adata->groups_max * sizeof(mdata));
  }
  adata->groups_list[adata->groups_num++] = mdata;
 
  return mdata;
}

Here is the call graph for this function:

Here is the caller graph for this function:

nntp_acache_free()

void nntp_acache_free

(

struct NntpMboxData *

mdata

)

Remove all temporarily cache files.

Parameters

mdata

NNTP Mailbox data

Definition at line 102 of file newsrc.c.

{
  for (int i = 0; i < NNTP_ACACHE_LEN; i++)
  {
    if (mdata->acache[i].path)
    {
      unlink(mdata->acache[i].path);
      FREE(&mdata->acache[i].path);
    }
  }
}

Here is the caller graph for this function:

nntp_newsrc_close()

void nntp_newsrc_close

(

struct NntpAccountData *

adata

)

Unlock and close .newsrc file.

Parameters

adata

NNTP server

Definition at line 118 of file newsrc.c.

{
  if (!adata->fp_newsrc)
    return;
 
  mutt_debug(LL_DEBUG1, "Unlocking %s\n", adata->newsrc_file);
  mutt_file_unlock(fileno(adata->fp_newsrc));
  mutt_file_fclose(&adata->fp_newsrc);
}

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

mdata

NNTP Mailbox data

Definition at line 132 of file newsrc.c.

{
  mdata->unread = 0;
  if ((mdata->last_message == 0) ||
      (mdata->first_message > mdata->last_message) || !mdata->newsrc_ent)
  {
    return;
  }
 
  mdata->unread = mdata->last_message - mdata->first_message + 1;
  for (unsigned int i = 0; i < mdata->newsrc_len; i++)
  {
    anum_t first = mdata->newsrc_ent[i].first;
    if (first < mdata->first_message)
      first = mdata->first_message;
    anum_t last = mdata->newsrc_ent[i].last;
    if (last > mdata->last_message)
      last = mdata->last_message;
    if (first <= last)
      mdata->unread -= last - first + 1;
  }
}

Here is the caller graph for this function:

nntp_newsrc_parse()

int nntp_newsrc_parse

(

struct NntpAccountData *

adata

)

Parse .newsrc file.

Parameters

adata

NNTP server

Return values

0	Not changed
1	Parsed
-1	Error

Definition at line 162 of file newsrc.c.

{
  if (!adata)
    return -1;
 
  char *line = NULL;
  struct stat st = { 0 };
 
  if (adata->fp_newsrc)
  {
    /* if we already have a handle, close it and reopen */
    mutt_file_fclose(&adata->fp_newsrc);
  }
  else
  {
    /* if file doesn't exist, create it */
    adata->fp_newsrc = mutt_file_fopen(adata->newsrc_file, "a");
    mutt_file_fclose(&adata->fp_newsrc);
  }
 
  /* open .newsrc */
  adata->fp_newsrc = mutt_file_fopen(adata->newsrc_file, "r");
  if (!adata->fp_newsrc)
  {
    mutt_perror(adata->newsrc_file);
    return -1;
  }
 
  /* lock it */
  mutt_debug(LL_DEBUG1, "Locking %s\n", adata->newsrc_file);
  if (mutt_file_lock(fileno(adata->fp_newsrc), false, true))
  {
    mutt_file_fclose(&adata->fp_newsrc);
    return -1;
  }
 
  if (stat(adata->newsrc_file, &st) != 0)
  {
    mutt_perror(adata->newsrc_file);
    nntp_newsrc_close(adata);
    return -1;
  }
 
  if ((adata->size == st.st_size) && (adata->mtime == st.st_mtime))
    return 0;
 
  adata->size = st.st_size;
  adata->mtime = st.st_mtime;
  adata->newsrc_modified = true;
  mutt_debug(LL_DEBUG1, "Parsing %s\n", adata->newsrc_file);
 
  /* .newsrc has been externally modified or hasn't been loaded yet */
  for (unsigned int i = 0; i < adata->groups_num; i++)
  {
    struct NntpMboxData *mdata = adata->groups_list[i];
    if (!mdata)
      continue;
 
    mdata->subscribed = false;
    mdata->newsrc_len = 0;
    FREE(&mdata->newsrc_ent);
  }
 
  line = mutt_mem_malloc(st.st_size + 1);
  while (st.st_size && fgets(line, st.st_size + 1, adata->fp_newsrc))
  {
    char *b = NULL, *h = NULL;
    unsigned int j = 1;
    bool subs = false;
 
    /* find end of newsgroup name */
    char *p = strpbrk(line, ":!");
    if (!p)
      continue;
 
    /* ":" - subscribed, "!" - unsubscribed */
    if (*p == ':')
      subs = true;
    *p++ = '\0';
 
    /* get newsgroup data */
    struct NntpMboxData *mdata = mdata_find(adata, line);
    FREE(&mdata->newsrc_ent);
 
    /* count number of entries */
    b = p;
    while (*b)
      if (*b++ == ',')
        j++;
    mdata->newsrc_ent = mutt_mem_calloc(j, sizeof(struct NewsrcEntry));
    mdata->subscribed = subs;
 
    /* parse entries */
    j = 0;
    while (p)
    {
      b = p;
 
      /* find end of entry */
      p = strchr(p, ',');
      if (p)
        *p++ = '\0';
 
      /* first-last or single number */
      h = strchr(b, '-');
      if (h)
        *h++ = '\0';
      else
        h = b;
 
      if ((sscanf(b, ANUM, &mdata->newsrc_ent[j].first) == 1) &&
          (sscanf(h, ANUM, &mdata->newsrc_ent[j].last) == 1))
      {
        j++;
      }
    }
    if (j == 0)
    {
      mdata->newsrc_ent[j].first = 1;
      mdata->newsrc_ent[j].last = 0;
      j++;
    }
    if (mdata->last_message == 0)
      mdata->last_message = mdata->newsrc_ent[j - 1].last;
    mdata->newsrc_len = j;
    mutt_mem_realloc(&mdata->newsrc_ent, j * sizeof(struct NewsrcEntry));
    nntp_group_unread_stat(mdata);
    mutt_debug(LL_DEBUG2, "%s\n", mdata->group);
  }
  FREE(&line);
  return 1;
}

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

m

Mailbox

Definition at line 299 of file newsrc.c.

{
  if (!m)
    return;
 
  struct NntpMboxData *mdata = m->mdata;
  anum_t last = 0, first = 1;
  bool series;
  unsigned int entries;
 
  const enum SortType c_sort = cs_subset_sort(NeoMutt->sub, "sort");
  if (c_sort != SORT_ORDER)
  {
    cs_subset_str_native_set(NeoMutt->sub, "sort", SORT_ORDER, NULL);
    mailbox_changed(m, NT_MAILBOX_RESORT);
  }
 
  entries = mdata->newsrc_len;
  if (!entries)
  {
    entries = 5;
    mdata->newsrc_ent = mutt_mem_calloc(entries, sizeof(struct NewsrcEntry));
  }
 
  /* Set up to fake initial sequence from 1 to the article before the
   * first article in our list */
  mdata->newsrc_len = 0;
  series = true;
  for (int i = 0; i < m->msg_count; i++)
  {
    struct Email *e = m->emails[i];
    if (!e)
      break;
 
    /* search for first unread */
    if (series)
    {
      /* We don't actually check sequential order, since we mark
       * "missing" entries as read/deleted */
      last = nntp_edata_get(e)->article_num;
      if ((last >= mdata->first_message) && !e->deleted && !e->read)
      {
        if (mdata->newsrc_len >= entries)
        {
          entries *= 2;
          mutt_mem_realloc(&mdata->newsrc_ent, entries * sizeof(struct NewsrcEntry));
        }
        mdata->newsrc_ent[mdata->newsrc_len].first = first;
        mdata->newsrc_ent[mdata->newsrc_len].last = last - 1;
        mdata->newsrc_len++;
        series = false;
      }
    }
    else
    {
      /* search for first read */
      if (e->deleted || e->read)
      {
        first = last + 1;
        series = true;
      }
      last = nntp_edata_get(e)->article_num;
    }
  }
 
  if (series && (first <= mdata->last_loaded))
  {
    if (mdata->newsrc_len >= entries)
    {
      entries++;
      mutt_mem_realloc(&mdata->newsrc_ent, entries * sizeof(struct NewsrcEntry));
    }
    mdata->newsrc_ent[mdata->newsrc_len].first = first;
    mdata->newsrc_ent[mdata->newsrc_len].last = mdata->last_loaded;
    mdata->newsrc_len++;
  }
  mutt_mem_realloc(&mdata->newsrc_ent, mdata->newsrc_len * sizeof(struct NewsrcEntry));
 
  if (c_sort != SORT_ORDER)
  {
    cs_subset_str_native_set(NeoMutt->sub, "sort", c_sort, NULL);
    mailbox_changed(m, NT_MAILBOX_RESORT);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

update_file()

static int update_file ( char *  filename, char *  buf  )

static

Update file with new contents.

Parameters

filename	File to update
buf	New context

Return values

0	Success
-1	Failure

Definition at line 391 of file newsrc.c.

{
  FILE *fp = NULL;
  char tmpfile[PATH_MAX] = { 0 };
  int rc = -1;
 
  while (true)
  {
    snprintf(tmpfile, sizeof(tmpfile), "%s.tmp", filename);
    fp = mutt_file_fopen(tmpfile, "w");
    if (!fp)
    {
      mutt_perror(tmpfile);
      *tmpfile = '\0';
      break;
    }
    if (fputs(buf, fp) == EOF)
    {
      mutt_perror(tmpfile);
      break;
    }
    if (mutt_file_fclose(&fp) == EOF)
    {
      mutt_perror(tmpfile);
      fp = NULL;
      break;
    }
    fp = NULL;
    if (rename(tmpfile, filename) < 0)
    {
      mutt_perror(filename);
      break;
    }
    *tmpfile = '\0';
    rc = 0;
    break;
  }
  mutt_file_fclose(&fp);
 
  if (*tmpfile)
    unlink(tmpfile);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

nntp_newsrc_update()

int nntp_newsrc_update

(

struct NntpAccountData *

adata

)

Update .newsrc file.

Parameters

adata

NNTP server

Return values

0	Success
-1	Failure

Definition at line 441 of file newsrc.c.

{
  if (!adata)
    return -1;
 
  int rc = -1;
 
  size_t buflen = 10240;
  char *buf = mutt_mem_calloc(1, buflen);
  size_t off = 0;
 
  /* we will generate full newsrc here */
  for (unsigned int i = 0; i < adata->groups_num; i++)
  {
    struct NntpMboxData *mdata = adata->groups_list[i];
 
    if (!mdata || !mdata->newsrc_ent)
      continue;
 
    /* write newsgroup name */
    if (off + strlen(mdata->group) + 3 > buflen)
    {
      buflen *= 2;
      mutt_mem_realloc(&buf, buflen);
    }
    snprintf(buf + off, buflen - off, "%s%c ", mdata->group, mdata->subscribed ? ':' : '!');
    off += strlen(buf + off);
 
    /* write entries */
    for (unsigned int j = 0; j < mdata->newsrc_len; j++)
    {
      if (off + 1024 > buflen)
      {
        buflen *= 2;
        mutt_mem_realloc(&buf, buflen);
      }
      if (j)
        buf[off++] = ',';
      if (mdata->newsrc_ent[j].first == mdata->newsrc_ent[j].last)
      {
        snprintf(buf + off, buflen - off, ANUM, mdata->newsrc_ent[j].first);
      }
      else if (mdata->newsrc_ent[j].first < mdata->newsrc_ent[j].last)
      {
        snprintf(buf + off, buflen - off, ANUM "-" ANUM,
                 mdata->newsrc_ent[j].first, mdata->newsrc_ent[j].last);
      }
      off += strlen(buf + off);
    }
    buf[off++] = '\n';
  }
  buf[off] = '\0';
 
  /* newrc being fully rewritten */
  mutt_debug(LL_DEBUG1, "Updating %s\n", adata->newsrc_file);
  if (adata->newsrc_file && (update_file(adata->newsrc_file, buf) == 0))
  {
    struct stat st = { 0 };
 
    rc = stat(adata->newsrc_file, &st);
    if (rc == 0)
    {
      adata->size = st.st_size;
      adata->mtime = st.st_mtime;
    }
    else
    {
      mutt_perror(adata->newsrc_file);
    }
  }
  FREE(&buf);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cache_expand()

static void cache_expand ( char *  dst, size_t  dstlen, struct ConnAccount *  cac, const char *  src  )

static

Make fully qualified cache file name.

Parameters

dst	Buffer for filename
dstlen	Length of buffer
cac	Account
src	Path to add to the URL

Definition at line 522 of file newsrc.c.

{
  char *c = NULL;
  char file[PATH_MAX] = { 0 };
 
  /* server subdirectory */
  if (cac)
  {
    struct Url url = { 0 };
 
    mutt_account_tourl(cac, &url);
    url.path = mutt_str_dup(src);
    url_tostring(&url, file, sizeof(file), U_PATH);
    FREE(&url.path);
  }
  else
  {
    mutt_str_copy(file, src ? src : "", sizeof(file));
  }
 
  const char *const c_news_cache_dir = cs_subset_path(NeoMutt->sub, "news_cache_dir");
  snprintf(dst, dstlen, "%s/%s", c_news_cache_dir, file);
 
  /* remove trailing slash */
  c = dst + strlen(dst) - 1;
  if (*c == '/')
    *c = '\0';
 
  struct Buffer *tmp = buf_pool_get();
  buf_addstr(tmp, dst);
  buf_expand_path(tmp);
  mutt_encode_path(tmp, dst);
  mutt_str_copy(dst, buf_string(tmp), dstlen);
  buf_pool_release(&tmp);
}

Here is the call graph for this function:

Here is the caller graph for this function:

nntp_expand_path()

void nntp_expand_path	(	char *	buf,
		size_t	buflen,
		struct ConnAccount *	cac
	)

Make fully qualified url from newsgroup name.

Parameters

buf	Buffer for the result
buflen	Length of buffer
cac	Account to serialise

Definition at line 564 of file newsrc.c.

{
  struct Url url = { 0 };
 
  mutt_account_tourl(cac, &url);
  url.path = mutt_str_dup(buf);
  url_tostring(&url, buf, buflen, U_NO_FLAGS);
  FREE(&url.path);
}

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

line	String to parse
data	NNTP data

Return values

0

Always

Definition at line 580 of file newsrc.c.

{
  struct NntpAccountData *adata = data;
  struct NntpMboxData *mdata = NULL;
  char group[1024] = { 0 };
  char desc[8192] = { 0 };
  char mod;
  anum_t first, last;
 
  if (!adata || !line)
    return 0;
 
  /* These sscanf limits must match the sizes of the group and desc arrays */
  if (sscanf(line, "%1023s " ANUM " " ANUM " %c %8191[^\n]", group, &last,
             &first, &mod, desc) < 4)
  {
    mutt_debug(LL_DEBUG2, "Can't parse server line: %s\n", line);
    return 0;
  }
 
  mdata = mdata_find(adata, group);
  mdata->deleted = false;
  mdata->first_message = first;
  mdata->last_message = last;
  mdata->allowed = (mod == 'y') || (mod == 'm');
  mutt_str_replace(&mdata->desc, desc);
  if (mdata->newsrc_ent || (mdata->last_cached != 0))
    nntp_group_unread_stat(mdata);
  else if (mdata->last_message && (mdata->first_message <= mdata->last_message))
    mdata->unread = mdata->last_message - mdata->first_message + 1;
  else
    mdata->unread = 0;
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

active_get_cache()

static int active_get_cache ( struct NntpAccountData *  adata )

static

Load list of all newsgroups from cache.

Parameters

adata

NNTP server

Return values

0	Success
-1	Failure

Definition at line 621 of file newsrc.c.

{
  char buf[8192] = { 0 };
  char file[4096] = { 0 };
  time_t t = 0;
 
  cache_expand(file, sizeof(file), &adata->conn->account, ".active");
  mutt_debug(LL_DEBUG1, "Parsing %s\n", file);
  FILE *fp = mutt_file_fopen(file, "r");
  if (!fp)
    return -1;
 
  if (!fgets(buf, sizeof(buf), fp) || (sscanf(buf, "%jd%4095s", &t, file) != 1) || (t == 0))
  {
    mutt_file_fclose(&fp);
    return -1;
  }
  adata->newgroups_time = t;
 
  mutt_message(_("Loading list of groups from cache..."));
  while (fgets(buf, sizeof(buf), fp))
    nntp_add_group(buf, adata);
  nntp_add_group(NULL, NULL);
  mutt_file_fclose(&fp);
  mutt_clear_error();
  return 0;
}

Here is the call graph for this function:

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

adata

NNTP server

Return values

0	Success
-1	Failure

Definition at line 655 of file newsrc.c.

{
  if (!adata->cacheable)
    return 0;
 
  size_t buflen = 10240;
  char *buf = mutt_mem_calloc(1, buflen);
  snprintf(buf, buflen, "%lu\n", (unsigned long) adata->newgroups_time);
  size_t off = strlen(buf);
 
  for (unsigned int i = 0; i < adata->groups_num; i++)
  {
    struct NntpMboxData *mdata = adata->groups_list[i];
 
    if (!mdata || mdata->deleted)
      continue;
 
    if ((off + strlen(mdata->group) + (mdata->desc ? strlen(mdata->desc) : 0) + 50) > buflen)
    {
      buflen *= 2;
      mutt_mem_realloc(&buf, buflen);
    }
    snprintf(buf + off, buflen - off, "%s " ANUM " " ANUM " %c%s%s\n", mdata->group,
             mdata->last_message, mdata->first_message, mdata->allowed ? 'y' : 'n',
             mdata->desc ? " " : "", mdata->desc ? mdata->desc : "");
    off += strlen(buf + off);
  }
 
  char file[PATH_MAX] = { 0 };
  cache_expand(file, sizeof(file), &adata->conn->account, ".active");
  mutt_debug(LL_DEBUG1, "Updating %s\n", file);
  int rc = update_file(file, buf);
  FREE(&buf);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

nntp_hcache_open()

struct HeaderCache * nntp_hcache_open

(

struct NntpMboxData *

mdata

)

Open newsgroup hcache.

Parameters

mdata

NNTP Mailbox data

Return values

ptr	Header cache
NULL	Error

Definition at line 714 of file newsrc.c.

{
  struct Url url = { 0 };
  char file[PATH_MAX] = { 0 };
 
  const bool c_save_unsubscribed = cs_subset_bool(NeoMutt->sub, "save_unsubscribed");
  if (!mdata->adata || !mdata->adata->cacheable || !mdata->adata->conn || !mdata->group ||
      !(mdata->newsrc_ent || mdata->subscribed || c_save_unsubscribed))
  {
    return NULL;
  }
 
  mutt_account_tourl(&mdata->adata->conn->account, &url);
  url.path = mdata->group;
  url_tostring(&url, file, sizeof(file), U_PATH);
  const char *const c_news_cache_dir = cs_subset_path(NeoMutt->sub, "news_cache_dir");
  return mutt_hcache_open(c_news_cache_dir, file, nntp_hcache_namer);
}

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

mdata	NNTP Mailbox data
hc	Header cache

Definition at line 738 of file newsrc.c.

{
  if (!hc)
    return;
 
  char buf[32] = { 0 };
  bool old = false;
  anum_t first = 0, last = 0;
 
  /* fetch previous values of first and last */
  char *hdata = mutt_hcache_fetch_str(hc, "index", 5);
  if (hdata)
  {
    mutt_debug(LL_DEBUG2, "mutt_hcache_fetch index: %s\n", hdata);
    if (sscanf(hdata, ANUM " " ANUM, &first, &last) == 2)
    {
      old = true;
      mdata->last_cached = last;
 
      /* clean removed headers from cache */
      for (anum_t current = first; current <= last; current++)
      {
        if ((current >= mdata->first_message) && (current <= mdata->last_message))
          continue;
 
        snprintf(buf, sizeof(buf), ANUM, current);
        mutt_debug(LL_DEBUG2, "mutt_hcache_delete_record %s\n", buf);
        mutt_hcache_delete_record(hc, buf, strlen(buf));
      }
    }
    FREE(&hdata);
  }
 
  /* store current values of first and last */
  if (!old || (mdata->first_message != first) || (mdata->last_message != last))
  {
    snprintf(buf, sizeof(buf), ANUM " " ANUM, mdata->first_message, mdata->last_message);
    mutt_debug(LL_DEBUG2, "mutt_hcache_store index: %s\n", buf);
    mutt_hcache_store_raw(hc, "index", 5, buf, strlen(buf) + 1);
  }
}

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

mdata

NNTP Mailbox data

Definition at line 805 of file newsrc.c.

{
  mutt_bcache_list(mdata->bcache, nntp_bcache_delete, mdata);
}

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

mdata

NNTP Mailbox data

Definition at line 814 of file newsrc.c.

{
  if (!mdata || !mdata->adata || !mdata->adata->cacheable)
    return;
 
#ifdef USE_HCACHE
  struct Buffer file = buf_make(PATH_MAX);
  nntp_hcache_namer(mdata->group, &file);
  cache_expand(file.data, file.dsize, &mdata->adata->conn->account, buf_string(&file));
  unlink(buf_string(&file));
  mdata->last_cached = 0;
  mutt_debug(LL_DEBUG2, "%s\n", buf_string(&file));
  buf_dealloc(&file);
#endif
 
  if (!mdata->bcache)
  {
    mdata->bcache = mutt_bcache_open(&mdata->adata->conn->account, mdata->group);
  }
  if (mdata->bcache)
  {
    mutt_debug(LL_DEBUG2, "%s/*\n", mdata->group);
    mutt_bcache_list(mdata->bcache, nntp_bcache_delete, NULL);
    mutt_bcache_close(&mdata->bcache);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

nntp_clear_cache()

void nntp_clear_cache

(

struct NntpAccountData *

adata

)

Clear the NNTP cache.

Parameters

adata

NNTP server

Remove hcache and bcache of all unexistent and unsubscribed newsgroups

Definition at line 847 of file newsrc.c.

{
  char file[PATH_MAX] = { 0 };
  char *fp = NULL;
  struct dirent *de = NULL;
  DIR *dir = NULL;
 
  if (!adata || !adata->cacheable)
    return;
 
  cache_expand(file, sizeof(file), &adata->conn->account, NULL);
  dir = mutt_file_opendir(file, MUTT_OPENDIR_NONE);
  if (dir)
  {
    mutt_strn_cat(file, sizeof(file), "/", 1);
    fp = file + strlen(file);
    while ((de = readdir(dir)))
    {
      char *group = de->d_name;
      struct stat st = { 0 };
      struct NntpMboxData *mdata = NULL;
      struct NntpMboxData tmp_mdata;
 
      if (mutt_str_equal(group, ".") || mutt_str_equal(group, ".."))
        continue;
      *fp = '\0';
      mutt_strn_cat(file, sizeof(file), group, strlen(group));
      if (stat(file, &st) != 0)
        continue;
 
#ifdef USE_HCACHE
      if (S_ISREG(st.st_mode))
      {
        char *ext = group + strlen(group) - 7;
        if ((strlen(group) < 8) || !mutt_str_equal(ext, ".hcache"))
          continue;
        *ext = '\0';
      }
      else
#endif
          if (!S_ISDIR(st.st_mode))
        continue;
 
      const bool c_save_unsubscribed = cs_subset_bool(NeoMutt->sub, "save_unsubscribed");
      mdata = mutt_hash_find(adata->groups_hash, group);
      if (!mdata)
      {
        mdata = &tmp_mdata;
        mdata->adata = adata;
        mdata->group = group;
        mdata->bcache = NULL;
      }
      else if (mdata->newsrc_ent || mdata->subscribed || c_save_unsubscribed)
      {
        continue;
      }
 
      nntp_delete_group_cache(mdata);
      if (S_ISDIR(st.st_mode))
      {
        rmdir(file);
        mutt_debug(LL_DEBUG2, "%s\n", file);
      }
    }
    closedir(dir);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

nntp_get_field()

static const char * nntp_get_field ( enum ConnAccountField  field, void *  gf_data  )

static

Get connection login credentials - Implements ConnAccount::get_field()

Definition at line 990 of file newsrc.c.

{
  switch (field)
  {
    case MUTT_CA_LOGIN:
    case MUTT_CA_USER:
      return cs_subset_string(NeoMutt->sub, "nntp_user");
    case MUTT_CA_PASS:
      return cs_subset_string(NeoMutt->sub, "nntp_pass");
    case MUTT_CA_OAUTH_CMD:
    case MUTT_CA_HOST:
    default:
      return NULL;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

nntp_select_server()

struct NntpAccountData * nntp_select_server	(	struct Mailbox *	m,
		const char *	server,
		bool	leave_lock
	)

Open a connection to an NNTP server.

Parameters

m	Mailbox
server	Server URL
leave_lock	Leave the server locked?

Return values

ptr	NNTP server
NULL	Error

Automatically loads a newsrc into memory, if necessary. Checks the size/mtime of a newsrc file, if it doesn't match, load again. Hmm, if a system has broken mtimes, this might mean the file is reloaded every time, which we'd have to fix.

See also

$newsrc, nntp_format_str()

Definition at line 1021 of file newsrc.c.

{
  char file[PATH_MAX] = { 0 };
  int rc;
  struct ConnAccount cac = { { 0 } };
  struct NntpAccountData *adata = NULL;
  struct Connection *conn = NULL;
 
  if (!server || (*server == '\0'))
  {
    mutt_error(_("No news server defined"));
    return NULL;
  }
 
  /* create account from news server url */
  cac.flags = 0;
  cac.port = NNTP_PORT;
  cac.type = MUTT_ACCT_TYPE_NNTP;
  cac.service = "nntp";
  cac.get_field = nntp_get_field;
 
  snprintf(file, sizeof(file), "%s%s", strstr(server, "://") ? "" : "news://", server);
  struct Url *url = url_parse(file);
  if (!url || (url->path && *url->path) ||
      !((url->scheme == U_NNTP) || (url->scheme == U_NNTPS)) || !url->host ||
      (mutt_account_fromurl(&cac, url) < 0))
  {
    url_free(&url);
    mutt_error(_("%s is an invalid news server specification"), server);
    return NULL;
  }
  if (url->scheme == U_NNTPS)
  {
    cac.flags |= MUTT_ACCT_SSL;
    cac.port = NNTP_SSL_PORT;
  }
  url_free(&url);
 
  // If nntp_user and nntp_pass are specified in the config, use them to find the connection
  const char *user = NULL;
  const char *pass = NULL;
  if ((user = cac.get_field(MUTT_CA_USER, NULL)))
  {
    mutt_str_copy(cac.user, user, sizeof(cac.user));
    cac.flags |= MUTT_ACCT_USER;
  }
  if ((pass = cac.get_field(MUTT_CA_PASS, NULL)))
  {
    mutt_str_copy(cac.pass, pass, sizeof(cac.pass));
    cac.flags |= MUTT_ACCT_PASS;
  }
 
  /* find connection by account */
  conn = mutt_conn_find(&cac);
  if (!conn)
    return NULL;
  if (!(conn->account.flags & MUTT_ACCT_USER) && cac.flags & MUTT_ACCT_USER)
  {
    conn->account.flags |= MUTT_ACCT_USER;
    conn->account.user[0] = '\0';
  }
 
  /* news server already exists */
  if (adata)
  {
    if (adata->status == NNTP_BYE)
      adata->status = NNTP_NONE;
    if (nntp_open_connection(adata) < 0)
      return NULL;
 
    rc = nntp_newsrc_parse(adata);
    if (rc < 0)
      return NULL;
 
    /* check for new newsgroups */
    if (!leave_lock && (nntp_check_new_groups(m, adata) < 0))
      rc = -1;
 
    /* .newsrc has been externally modified */
    if (rc > 0)
      nntp_clear_cache(adata);
    if ((rc < 0) || !leave_lock)
      nntp_newsrc_close(adata);
    return (rc < 0) ? NULL : adata;
  }
 
  /* new news server */
  adata = nntp_adata_new(conn);
 
  rc = nntp_open_connection(adata);
 
  /* try to create cache directory and enable caching */
  adata->cacheable = false;
  const char *const c_news_cache_dir = cs_subset_path(NeoMutt->sub, "news_cache_dir");
  if ((rc >= 0) && c_news_cache_dir)
  {
    cache_expand(file, sizeof(file), &conn->account, NULL);
    if (mutt_file_mkdir(file, S_IRWXU) < 0)
    {
      mutt_error(_("Can't create %s: %s"), file, strerror(errno));
    }
    adata->cacheable = true;
  }
 
  /* load .newsrc */
  if (rc >= 0)
  {
    const char *const c_newsrc = cs_subset_path(NeoMutt->sub, "newsrc");
    mutt_expando_format(file, sizeof(file), 0, sizeof(file), NONULL(c_newsrc),
                        nntp_format_str, (intptr_t) adata, MUTT_FORMAT_NO_FLAGS);
    mutt_expand_path(file, sizeof(file));
    adata->newsrc_file = mutt_str_dup(file);
    rc = nntp_newsrc_parse(adata);
  }
  if (rc >= 0)
  {
    /* try to load list of newsgroups from cache */
    if (adata->cacheable && (active_get_cache(adata) == 0))
    {
      rc = nntp_check_new_groups(m, adata);
    }
    else
    {
      /* load list of newsgroups from server */
      rc = nntp_active_fetch(adata, false);
    }
  }
 
  if (rc >= 0)
    nntp_clear_cache(adata);
 
#ifdef USE_HCACHE
  /* check cache files */
  if ((rc >= 0) && adata->cacheable)
  {
    struct dirent *de = NULL;
    DIR *dir = mutt_file_opendir(file, MUTT_OPENDIR_NONE);
 
    if (dir)
    {
      while ((de = readdir(dir)))
      {
        struct HeaderCache *hc = NULL;
        char *group = de->d_name;
 
        char *p = group + strlen(group) - 7;
        if ((strlen(group) < 8) || !mutt_str_equal(p, ".hcache"))
          continue;
        *p = '\0';
        struct NntpMboxData *mdata = mutt_hash_find(adata->groups_hash, group);
        if (!mdata)
          continue;
 
        hc = nntp_hcache_open(mdata);
        if (!hc)
          continue;
 
        /* fetch previous values of first and last */
        char *hdata = mutt_hcache_fetch_str(hc, "index", 5);
        if (hdata)
        {
          anum_t first, last;
 
          if (sscanf(hdata, ANUM " " ANUM, &first, &last) == 2)
          {
            if (mdata->deleted)
            {
              mdata->first_message = first;
              mdata->last_message = last;
            }
            if ((last >= mdata->first_message) && (last <= mdata->last_message))
            {
              mdata->last_cached = last;
              mutt_debug(LL_DEBUG2, "%s last_cached=" ANUM "\n", mdata->group, last);
            }
          }
          FREE(&hdata);
        }
        mutt_hcache_close(hc);
      }
      closedir(dir);
    }
  }
#endif
 
  if ((rc < 0) || !leave_lock)
    nntp_newsrc_close(adata);
 
  if (rc < 0)
  {
    mutt_hash_free(&adata->groups_hash);
    FREE(&adata->groups_list);
    FREE(&adata->newsrc_file);
    FREE(&adata->authenticators);
    FREE(&adata);
    mutt_socket_close(conn);
    FREE(&conn);
    return NULL;
  }
 
  return adata;
}

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

m	Mailbox
e	Email
group	Newsgroup
anum	Article 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 1236 of file newsrc.c.

{
  struct NntpMboxData *mdata = m->mdata;
 
  if (group)
    mdata = mutt_hash_find(mdata->adata->groups_hash, group);
 
  if (!mdata)
    return;
 
  for (unsigned int i = 0; i < mdata->newsrc_len; i++)
  {
    if ((anum >= mdata->newsrc_ent[i].first) && (anum <= mdata->newsrc_ent[i].last))
    {
      /* can't use mutt_set_flag() because mview_update() didn't get called yet */
      e->read = true;
      return;
    }
  }
 
  /* article was not cached yet, it's new */
  if (anum > mdata->last_cached)
    return;
 
  /* article isn't read but cached, it's old */
  const bool c_mark_old = cs_subset_bool(NeoMutt->sub, "mark_old");
  if (c_mark_old)
    e->old = true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_newsgroup_subscribe()

struct NntpMboxData * mutt_newsgroup_subscribe	(	struct NntpAccountData *	adata,
		char *	group
	)

Subscribe newsgroup.

Parameters

adata	NNTP server
group	Newsgroup

Return values

ptr	NNTP data
NULL	Error

Definition at line 1273 of file newsrc.c.

{
  if (!adata || !adata->groups_hash || !group || (*group == '\0'))
    return NULL;
 
  struct NntpMboxData *mdata = mdata_find(adata, group);
  mdata->subscribed = true;
  if (!mdata->newsrc_ent)
  {
    mdata->newsrc_ent = mutt_mem_calloc(1, sizeof(struct NewsrcEntry));
    mdata->newsrc_len = 1;
    mdata->newsrc_ent[0].first = 1;
    mdata->newsrc_ent[0].last = 0;
  }
  return mdata;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_newsgroup_unsubscribe()

struct NntpMboxData * mutt_newsgroup_unsubscribe	(	struct NntpAccountData *	adata,
		char *	group
	)

Unsubscribe newsgroup.

Parameters

adata	NNTP server
group	Newsgroup

Return values

ptr	NNTP data
NULL	Error

Definition at line 1297 of file newsrc.c.

{
  if (!adata || !adata->groups_hash || !group || (*group == '\0'))
    return NULL;
 
  struct NntpMboxData *mdata = mutt_hash_find(adata->groups_hash, group);
  if (!mdata)
    return NULL;
 
  mdata->subscribed = false;
  const bool c_save_unsubscribed = cs_subset_bool(NeoMutt->sub, "save_unsubscribed");
  if (!c_save_unsubscribed)
  {
    mdata->newsrc_len = 0;
    FREE(&mdata->newsrc_ent);
  }
  return mdata;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_newsgroup_catchup()

struct NntpMboxData * mutt_newsgroup_catchup	(	struct Mailbox *	m,
		struct NntpAccountData *	adata,
		char *	group
	)

Catchup newsgroup.

Parameters

m	Mailbox
adata	NNTP server
group	Newsgroup

Return values

ptr	NNTP data
NULL	Error

Definition at line 1324 of file newsrc.c.

{
  if (!adata || !adata->groups_hash || !group || (*group == '\0'))
    return NULL;
 
  struct NntpMboxData *mdata = mutt_hash_find(adata->groups_hash, group);
  if (!mdata)
    return NULL;
 
  if (mdata->newsrc_ent)
  {
    mutt_mem_realloc(&mdata->newsrc_ent, sizeof(struct NewsrcEntry));
    mdata->newsrc_len = 1;
    mdata->newsrc_ent[0].first = 1;
    mdata->newsrc_ent[0].last = mdata->last_message;
  }
  mdata->unread = 0;
  if (m && (m->mdata == mdata))
  {
    for (unsigned int i = 0; i < m->msg_count; i++)
    {
      struct Email *e = m->emails[i];
      if (!e)
        break;
      mutt_set_flag(m, e, MUTT_READ, true, true);
    }
  }
  return mdata;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_newsgroup_uncatchup()

struct NntpMboxData * mutt_newsgroup_uncatchup	(	struct Mailbox *	m,
		struct NntpAccountData *	adata,
		char *	group
	)

Uncatchup newsgroup.

Parameters

m	Mailbox
adata	NNTP server
group	Newsgroup

Return values

ptr	NNTP data
NULL	Error

Definition at line 1363 of file newsrc.c.

{
  if (!adata || !adata->groups_hash || !group || (*group == '\0'))
    return NULL;
 
  struct NntpMboxData *mdata = mutt_hash_find(adata->groups_hash, group);
  if (!mdata)
    return NULL;
 
  if (mdata->newsrc_ent)
  {
    mutt_mem_realloc(&mdata->newsrc_ent, sizeof(struct NewsrcEntry));
    mdata->newsrc_len = 1;
    mdata->newsrc_ent[0].first = 1;
    mdata->newsrc_ent[0].last = mdata->first_message - 1;
  }
  if (m && (m->mdata == mdata))
  {
    mdata->unread = m->msg_count;
    for (unsigned int i = 0; i < m->msg_count; i++)
    {
      struct Email *e = m->emails[i];
      if (!e)
        break;
      mutt_set_flag(m, e, MUTT_READ, false, true);
    }
  }
  else
  {
    mdata->unread = mdata->last_message;
    if (mdata->newsrc_ent)
      mdata->unread -= mdata->newsrc_ent[0].last;
  }
  return mdata;
}

Here is the call graph for this function:

Here is the caller graph for this function:

nntp_mailbox()

void nntp_mailbox	(	struct Mailbox *	m,
		char *	buf,
		size_t	buflen
	)

Get first newsgroup with new messages.

Parameters

m	Mailbox
buf	Buffer for result
buflen	Length of buffer

Definition at line 1406 of file newsrc.c.

{
  if (!m)
    return;
 
  for (unsigned int i = 0; i < CurrentNewsSrv->groups_num; i++)
  {
    struct NntpMboxData *mdata = CurrentNewsSrv->groups_list[i];
 
    if (!mdata || !mdata->subscribed || !mdata->unread)
      continue;
 
    if ((m->type == MUTT_NNTP) &&
        mutt_str_equal(mdata->group, ((struct NntpMboxData *) m->mdata)->group))
    {
      unsigned int unread = 0;
 
      for (unsigned int j = 0; j < m->msg_count; j++)
      {
        struct Email *e = m->emails[j];
        if (!e)
          break;
        if (!e->read && !e->deleted)
          unread++;
      }
      if (unread == 0)
        continue;
    }
    mutt_str_copy(buf, mdata->group, buflen);
    break;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function: